From af4a59559d5924be461206e52cce2e6508d2e28c Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Tue, 15 Jul 2025 17:27:14 +0000 Subject: [PATCH] Update Go SDK docs: 16300048992 --- .../V2025/Methods/CustomUserLevelsAPI.md | 617 ++++++++++++++++++ .../V2025/Models/HierarchicalRightSet.md | 204 ++++++ .../go/Reference/V2025/Models/NestedConfig.md | 152 +++++ .../go/Reference/V2025/Models/RightSetDTO.md | 344 ++++++++++ .../V2025/Models/UserLevelPublishSummary.md | 142 ++++ .../V2025/Models/UserLevelRequest.md | 127 ++++ .../V2025/Models/UserLevelSummaryDTO.md | 488 ++++++++++++++ .../v2025/go_code_examples_overlay.yaml | 282 ++++++++ 8 files changed, 2356 insertions(+) create mode 100644 docs/tools/sdk/go/Reference/V2025/Methods/CustomUserLevelsAPI.md create mode 100644 docs/tools/sdk/go/Reference/V2025/Models/HierarchicalRightSet.md create mode 100644 docs/tools/sdk/go/Reference/V2025/Models/NestedConfig.md create mode 100644 docs/tools/sdk/go/Reference/V2025/Models/RightSetDTO.md create mode 100644 docs/tools/sdk/go/Reference/V2025/Models/UserLevelPublishSummary.md create mode 100644 docs/tools/sdk/go/Reference/V2025/Models/UserLevelRequest.md create mode 100644 docs/tools/sdk/go/Reference/V2025/Models/UserLevelSummaryDTO.md diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/CustomUserLevelsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/CustomUserLevelsAPI.md new file mode 100644 index 000000000..17d2256b1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/CustomUserLevelsAPI.md @@ -0,0 +1,617 @@ +--- +id: v2025-custom-user-levels +title: CustomUserLevels +pagination_label: CustomUserLevels +sidebar_label: CustomUserLevels +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CustomUserLevels', 'V2025CustomUserLevels'] +slug: /tools/sdk/go/v2025/methods/custom-user-levels +tags: ['SDK', 'Software Development Kit', 'CustomUserLevels', 'V2025CustomUserLevels'] +--- + +# CustomUserLevelsAPI + Use this API to implement custom user level functionality. +With this functionality in place, administrators can create custom user levels and configure them for use throughout Identity Security Cloud. + +Custom user levels allow administrators to create custom user levels that can be used to control access to Identity Security Cloud features and APIs. + +Refer to [User Levels](https://documentation.sailpoint.com/saas/help/common/users/index.html) for more information about User Levels. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-custom-user-level**](#create-custom-user-level) | **Post** `/authorization/custom-user-levels` | Create a custom user level +[**delete-user-level**](#delete-user-level) | **Delete** `/authorization/custom-user-levels/{id}` | Delete a user level +[**get-user-level**](#get-user-level) | **Get** `/authorization/custom-user-levels/{id}` | Retrieve a user level +[**list-all-authorization-right-sets**](#list-all-authorization-right-sets) | **Get** `/authorization/authorization-assignable-right-sets` | List all uiAssignable right sets +[**list-user-levels**](#list-user-levels) | **Get** `/authorization/custom-user-levels` | List user levels +[**publish-custom-user-level**](#publish-custom-user-level) | **Post** `/authorization/custom-user-levels/{id}/publish` | Publish a custom user level +[**update-user-level**](#update-user-level) | **Patch** `/authorization/custom-user-levels/{id}` | Update a user level + + +## create-custom-user-level +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you 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 custom user level +Creates a new custom user level for the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-custom-user-level) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateCustomUserLevelRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **userLevelRequest** | [**UserLevelRequest**](../models/user-level-request) | Payload containing the details of the user level to be created. | + +### Return type + +[**UserLevelSummaryDTO**](../models/user-level-summary-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") + userlevelrequest := []byte(`{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "rightSets" : [ "idn:ui-right-set-list-read-example", "idn:ui-right-set-write-example" ], + "name" : "Custom User Level Name", + "description" : "This is a description of the custom user level." + }`) // UserLevelRequest | Payload containing the details of the user level to be created. + + var userLevelRequest v2025.UserLevelRequest + if err := json.Unmarshal(userlevelrequest, &userLevelRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomUserLevelsAPI.CreateCustomUserLevel(context.Background()).XSailPointExperimental(xSailPointExperimental).UserLevelRequest(userLevelRequest).Execute() + //resp, r, err := apiClient.V2025.CustomUserLevelsAPI.CreateCustomUserLevel(context.Background()).XSailPointExperimental(xSailPointExperimental).UserLevelRequest(userLevelRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomUserLevelsAPI.CreateCustomUserLevel``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCustomUserLevel`: UserLevelSummaryDTO + fmt.Fprintf(os.Stdout, "Response from `CustomUserLevelsAPI.CreateCustomUserLevel`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-user-level +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you 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 user level +Deletes a specific user level by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-user-level) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The unique identifier of the user level. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteUserLevelRequest 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() { + xSailPointExperimental := `true` // 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 := `6e110911-5984-491b-be74-2707980a46a7` // string | The unique identifier of the user level. # string | The unique identifier of the user level. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.CustomUserLevelsAPI.DeleteUserLevel(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.CustomUserLevelsAPI.DeleteUserLevel(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomUserLevelsAPI.DeleteUserLevel``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + +} +``` + +[[Back to top]](#) + +## get-user-level +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you 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 a user level +Fetches the details of a specific user level by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-user-level) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The unique identifier of the user level. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetUserLevelRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + + +### Return type + +[**UserLevelSummaryDTO**](../models/user-level-summary-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") + id := `6e110911-5984-491b-be74-2707980a46a7` // string | The unique identifier of the user level. # string | The unique identifier of the user level. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomUserLevelsAPI.GetUserLevel(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.CustomUserLevelsAPI.GetUserLevel(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomUserLevelsAPI.GetUserLevel``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetUserLevel`: UserLevelSummaryDTO + fmt.Fprintf(os.Stdout, "Response from `CustomUserLevelsAPI.GetUserLevel`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-all-authorization-right-sets +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you 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 uiAssignable right sets +Retrieves a list of authorization assignable right sets for the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-all-authorization-right-sets) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAllAuthorizationRightSetsRequest 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: **category**: *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, category** | + **limit** | **int32** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to 250] + **offset** | **int32** | Offset into the full result set. Usually specified with *limit* to paginate 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 + +[**[]HierarchicalRightSet**](../models/hierarchical-right-set) + +### HTTP request headers + +- **Content-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 := `category eq "identity"` // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **category**: *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: **category**: *eq* (optional) + sorters := `name, -id, -category` // string | Sort results using the standard syntax described 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, category** (optional) # string | Sort results using the standard syntax described 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, category** (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.CustomUserLevelsAPI.ListAllAuthorizationRightSets(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.CustomUserLevelsAPI.ListAllAuthorizationRightSets(context.Background()).XSailPointExperimental(xSailPointExperimental).Filters(filters).Sorters(sorters).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomUserLevelsAPI.ListAllAuthorizationRightSets``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAllAuthorizationRightSets`: []HierarchicalRightSet + fmt.Fprintf(os.Stdout, "Response from `CustomUserLevelsAPI.ListAllAuthorizationRightSets`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-user-levels +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you 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 user levels +Retrieves a list of user levels for the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-user-levels) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListUserLevelsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **detailLevel** | **string** | Specifies the level of detail for the user levels. | + **filters** | **string** | Filter results using the standard syntax described in [V3 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**: *co* **owner**: *co* **status**: *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** | + **limit** | **int32** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to 250] + **offset** | **int32** | Offset into the full result set. Usually specified with *limit* to paginate 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 + +[**[]UserLevelSummaryDTO**](../models/user-level-summary-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") + detailLevel := `detailLevel=FULL` // string | Specifies the level of detail for the user levels. (optional) # string | Specifies the level of detail for the user levels. (optional) + filters := `name co "identity", owner co "john", status eq "active"` // string | Filter results using the standard syntax described in [V3 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**: *co* **owner**: *co* **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: **name**: *co* **owner**: *co* **status**: *eq* (optional) + 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** (optional) # string | Sort results using the standard syntax described in [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) + limit := 250 // int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset := 0 // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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.CustomUserLevelsAPI.ListUserLevels(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.CustomUserLevelsAPI.ListUserLevels(context.Background()).XSailPointExperimental(xSailPointExperimental).DetailLevel(detailLevel).Filters(filters).Sorters(sorters).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomUserLevelsAPI.ListUserLevels``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListUserLevels`: []UserLevelSummaryDTO + fmt.Fprintf(os.Stdout, "Response from `CustomUserLevelsAPI.ListUserLevels`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## publish-custom-user-level +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you 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 a custom user level +Publishes a custom user level for the tenant, making it active and available. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/publish-custom-user-level) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The unique identifier of the user level to publish. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPublishCustomUserLevelRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + + +### Return type + +[**UserLevelPublishSummary**](../models/user-level-publish-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") + id := `6e110911-5984-491b-be74-2707980a46a7` // string | The unique identifier of the user level to publish. # string | The unique identifier of the user level to publish. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomUserLevelsAPI.PublishCustomUserLevel(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.CustomUserLevelsAPI.PublishCustomUserLevel(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomUserLevelsAPI.PublishCustomUserLevel``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PublishCustomUserLevel`: UserLevelPublishSummary + fmt.Fprintf(os.Stdout, "Response from `CustomUserLevelsAPI.PublishCustomUserLevel`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-user-level +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you 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 user level +Updates the details of a specific user level using JSON Patch. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-user-level) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The unique identifier of the user level. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateUserLevelRequest 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) | JSON Patch payload for updating the user level. | + +### Return type + +[**UserLevelSummaryDTO**](../models/user-level-summary-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() { + xSailPointExperimental := `true` // 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 := `6e110911-5984-491b-be74-2707980a46a7` // string | The unique identifier of the user level. # string | The unique identifier of the user level. + jsonpatch := []byte(`{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }`) // JsonPatch | JSON Patch payload for updating the user level. + + 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.CustomUserLevelsAPI.UpdateUserLevel(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatch(jsonPatch).Execute() + //resp, r, err := apiClient.V2025.CustomUserLevelsAPI.UpdateUserLevel(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatch(jsonPatch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomUserLevelsAPI.UpdateUserLevel``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateUserLevel`: UserLevelSummaryDTO + fmt.Fprintf(os.Stdout, "Response from `CustomUserLevelsAPI.UpdateUserLevel`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/HierarchicalRightSet.md b/docs/tools/sdk/go/Reference/V2025/Models/HierarchicalRightSet.md new file mode 100644 index 000000000..f00102a99 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/HierarchicalRightSet.md @@ -0,0 +1,204 @@ +--- +id: v2025-hierarchical-right-set +title: HierarchicalRightSet +pagination_label: HierarchicalRightSet +sidebar_label: HierarchicalRightSet +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'HierarchicalRightSet', 'V2025HierarchicalRightSet'] +slug: /tools/sdk/go/v2025/models/hierarchical-right-set +tags: ['SDK', 'Software Development Kit', 'HierarchicalRightSet', 'V2025HierarchicalRightSet'] +--- + +# HierarchicalRightSet + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique identifier of the RightSet. | [optional] +**Name** | Pointer to **string** | The human-readable name of the RightSet. | [optional] +**Description** | Pointer to **NullableString** | A human-readable description of the RightSet. | [optional] +**Category** | Pointer to **string** | The category of the RightSet. | [optional] +**NestedConfig** | Pointer to [**NestedConfig**](nested-config) | | [optional] +**Children** | Pointer to [**[]HierarchicalRightSet**](hierarchical-right-set) | List of child HierarchicalRightSets. | [optional] + +## Methods + +### NewHierarchicalRightSet + +`func NewHierarchicalRightSet() *HierarchicalRightSet` + +NewHierarchicalRightSet instantiates a new HierarchicalRightSet object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewHierarchicalRightSetWithDefaults + +`func NewHierarchicalRightSetWithDefaults() *HierarchicalRightSet` + +NewHierarchicalRightSetWithDefaults instantiates a new HierarchicalRightSet object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *HierarchicalRightSet) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *HierarchicalRightSet) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *HierarchicalRightSet) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *HierarchicalRightSet) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *HierarchicalRightSet) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *HierarchicalRightSet) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *HierarchicalRightSet) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *HierarchicalRightSet) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *HierarchicalRightSet) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *HierarchicalRightSet) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *HierarchicalRightSet) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *HierarchicalRightSet) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *HierarchicalRightSet) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *HierarchicalRightSet) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetCategory + +`func (o *HierarchicalRightSet) GetCategory() string` + +GetCategory returns the Category field if non-nil, zero value otherwise. + +### GetCategoryOk + +`func (o *HierarchicalRightSet) 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 *HierarchicalRightSet) SetCategory(v string)` + +SetCategory sets Category field to given value. + +### HasCategory + +`func (o *HierarchicalRightSet) HasCategory() bool` + +HasCategory returns a boolean if a field has been set. + +### GetNestedConfig + +`func (o *HierarchicalRightSet) GetNestedConfig() NestedConfig` + +GetNestedConfig returns the NestedConfig field if non-nil, zero value otherwise. + +### GetNestedConfigOk + +`func (o *HierarchicalRightSet) GetNestedConfigOk() (*NestedConfig, bool)` + +GetNestedConfigOk returns a tuple with the NestedConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNestedConfig + +`func (o *HierarchicalRightSet) SetNestedConfig(v NestedConfig)` + +SetNestedConfig sets NestedConfig field to given value. + +### HasNestedConfig + +`func (o *HierarchicalRightSet) HasNestedConfig() bool` + +HasNestedConfig returns a boolean if a field has been set. + +### GetChildren + +`func (o *HierarchicalRightSet) GetChildren() []HierarchicalRightSet` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *HierarchicalRightSet) GetChildrenOk() (*[]HierarchicalRightSet, 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 *HierarchicalRightSet) SetChildren(v []HierarchicalRightSet)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *HierarchicalRightSet) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NestedConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/NestedConfig.md new file mode 100644 index 000000000..a91566cd9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NestedConfig.md @@ -0,0 +1,152 @@ +--- +id: v2025-nested-config +title: NestedConfig +pagination_label: NestedConfig +sidebar_label: NestedConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NestedConfig', 'V2025NestedConfig'] +slug: /tools/sdk/go/v2025/models/nested-config +tags: ['SDK', 'Software Development Kit', 'NestedConfig', 'V2025NestedConfig'] +--- + +# NestedConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AncestorId** | Pointer to **string** | The unique identifier of the ancestor RightSet. | [optional] +**Depth** | Pointer to **int32** | The depth level of the configuration. | [optional] +**ParentId** | Pointer to **NullableString** | The unique identifier of the parent RightSet. | [optional] +**ChildrenIds** | Pointer to **[]string** | List of unique identifiers for child configurations. | [optional] + +## Methods + +### NewNestedConfig + +`func NewNestedConfig() *NestedConfig` + +NewNestedConfig instantiates a new NestedConfig object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNestedConfigWithDefaults + +`func NewNestedConfigWithDefaults() *NestedConfig` + +NewNestedConfigWithDefaults instantiates a new NestedConfig object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAncestorId + +`func (o *NestedConfig) GetAncestorId() string` + +GetAncestorId returns the AncestorId field if non-nil, zero value otherwise. + +### GetAncestorIdOk + +`func (o *NestedConfig) GetAncestorIdOk() (*string, bool)` + +GetAncestorIdOk returns a tuple with the AncestorId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAncestorId + +`func (o *NestedConfig) SetAncestorId(v string)` + +SetAncestorId sets AncestorId field to given value. + +### HasAncestorId + +`func (o *NestedConfig) HasAncestorId() bool` + +HasAncestorId returns a boolean if a field has been set. + +### GetDepth + +`func (o *NestedConfig) GetDepth() int32` + +GetDepth returns the Depth field if non-nil, zero value otherwise. + +### GetDepthOk + +`func (o *NestedConfig) GetDepthOk() (*int32, bool)` + +GetDepthOk returns a tuple with the Depth field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDepth + +`func (o *NestedConfig) SetDepth(v int32)` + +SetDepth sets Depth field to given value. + +### HasDepth + +`func (o *NestedConfig) HasDepth() bool` + +HasDepth returns a boolean if a field has been set. + +### GetParentId + +`func (o *NestedConfig) GetParentId() string` + +GetParentId returns the ParentId field if non-nil, zero value otherwise. + +### GetParentIdOk + +`func (o *NestedConfig) 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 *NestedConfig) SetParentId(v string)` + +SetParentId sets ParentId field to given value. + +### HasParentId + +`func (o *NestedConfig) HasParentId() bool` + +HasParentId returns a boolean if a field has been set. + +### SetParentIdNil + +`func (o *NestedConfig) SetParentIdNil(b bool)` + + SetParentIdNil sets the value for ParentId to be an explicit nil + +### UnsetParentId +`func (o *NestedConfig) UnsetParentId()` + +UnsetParentId ensures that no value is present for ParentId, not even an explicit nil +### GetChildrenIds + +`func (o *NestedConfig) GetChildrenIds() []string` + +GetChildrenIds returns the ChildrenIds field if non-nil, zero value otherwise. + +### GetChildrenIdsOk + +`func (o *NestedConfig) GetChildrenIdsOk() (*[]string, bool)` + +GetChildrenIdsOk returns a tuple with the ChildrenIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildrenIds + +`func (o *NestedConfig) SetChildrenIds(v []string)` + +SetChildrenIds sets ChildrenIds field to given value. + +### HasChildrenIds + +`func (o *NestedConfig) HasChildrenIds() bool` + +HasChildrenIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RightSetDTO.md b/docs/tools/sdk/go/Reference/V2025/Models/RightSetDTO.md new file mode 100644 index 000000000..c964713b0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RightSetDTO.md @@ -0,0 +1,344 @@ +--- +id: v2025-right-set-dto +title: RightSetDTO +pagination_label: RightSetDTO +sidebar_label: RightSetDTO +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RightSetDTO', 'V2025RightSetDTO'] +slug: /tools/sdk/go/v2025/models/right-set-dto +tags: ['SDK', 'Software Development Kit', 'RightSetDTO', 'V2025RightSetDTO'] +--- + +# RightSetDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique identifier of the RightSet. | [optional] +**Name** | Pointer to **string** | The human-readable name of the RightSet. | [optional] +**Description** | Pointer to **string** | A human-readable description of the RightSet. | [optional] +**Category** | Pointer to **string** | The category of the RightSet. | [optional] +**Rights** | Pointer to **[]string** | Right is the most granular unit that determines specific API permissions, this is a list of rights associated with the RightSet. | [optional] +**RightSetIds** | Pointer to **[]string** | List of unique identifiers for related RightSets, current RightSet contains rights from these RightSets. | [optional] +**UiAssignableChildRightSetIds** | Pointer to **[]string** | List of unique identifiers for UI-assignable child RightSets, used to build UI components. | [optional] +**UiAssignable** | Pointer to **bool** | Indicates whether the RightSet is UI-assignable. | [optional] [default to false] +**TranslatedName** | Pointer to **string** | The translated name of the RightSet. | [optional] +**TranslatedDescription** | Pointer to **NullableString** | The translated description of the RightSet. | [optional] +**ParentId** | Pointer to **NullableString** | The unique identifier of the parent RightSet for UI Assignable RightSet. | [optional] + +## Methods + +### NewRightSetDTO + +`func NewRightSetDTO() *RightSetDTO` + +NewRightSetDTO instantiates a new RightSetDTO object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewRightSetDTOWithDefaults + +`func NewRightSetDTOWithDefaults() *RightSetDTO` + +NewRightSetDTOWithDefaults instantiates a new RightSetDTO object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *RightSetDTO) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RightSetDTO) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RightSetDTO) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RightSetDTO) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RightSetDTO) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RightSetDTO) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RightSetDTO) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RightSetDTO) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *RightSetDTO) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RightSetDTO) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RightSetDTO) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RightSetDTO) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetCategory + +`func (o *RightSetDTO) GetCategory() string` + +GetCategory returns the Category field if non-nil, zero value otherwise. + +### GetCategoryOk + +`func (o *RightSetDTO) 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 *RightSetDTO) SetCategory(v string)` + +SetCategory sets Category field to given value. + +### HasCategory + +`func (o *RightSetDTO) HasCategory() bool` + +HasCategory returns a boolean if a field has been set. + +### GetRights + +`func (o *RightSetDTO) GetRights() []string` + +GetRights returns the Rights field if non-nil, zero value otherwise. + +### GetRightsOk + +`func (o *RightSetDTO) 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 *RightSetDTO) SetRights(v []string)` + +SetRights sets Rights field to given value. + +### HasRights + +`func (o *RightSetDTO) HasRights() bool` + +HasRights returns a boolean if a field has been set. + +### GetRightSetIds + +`func (o *RightSetDTO) GetRightSetIds() []string` + +GetRightSetIds returns the RightSetIds field if non-nil, zero value otherwise. + +### GetRightSetIdsOk + +`func (o *RightSetDTO) GetRightSetIdsOk() (*[]string, bool)` + +GetRightSetIdsOk returns a tuple with the RightSetIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRightSetIds + +`func (o *RightSetDTO) SetRightSetIds(v []string)` + +SetRightSetIds sets RightSetIds field to given value. + +### HasRightSetIds + +`func (o *RightSetDTO) HasRightSetIds() bool` + +HasRightSetIds returns a boolean if a field has been set. + +### GetUiAssignableChildRightSetIds + +`func (o *RightSetDTO) GetUiAssignableChildRightSetIds() []string` + +GetUiAssignableChildRightSetIds returns the UiAssignableChildRightSetIds field if non-nil, zero value otherwise. + +### GetUiAssignableChildRightSetIdsOk + +`func (o *RightSetDTO) GetUiAssignableChildRightSetIdsOk() (*[]string, bool)` + +GetUiAssignableChildRightSetIdsOk returns a tuple with the UiAssignableChildRightSetIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUiAssignableChildRightSetIds + +`func (o *RightSetDTO) SetUiAssignableChildRightSetIds(v []string)` + +SetUiAssignableChildRightSetIds sets UiAssignableChildRightSetIds field to given value. + +### HasUiAssignableChildRightSetIds + +`func (o *RightSetDTO) HasUiAssignableChildRightSetIds() bool` + +HasUiAssignableChildRightSetIds returns a boolean if a field has been set. + +### GetUiAssignable + +`func (o *RightSetDTO) GetUiAssignable() bool` + +GetUiAssignable returns the UiAssignable field if non-nil, zero value otherwise. + +### GetUiAssignableOk + +`func (o *RightSetDTO) GetUiAssignableOk() (*bool, bool)` + +GetUiAssignableOk returns a tuple with the UiAssignable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUiAssignable + +`func (o *RightSetDTO) SetUiAssignable(v bool)` + +SetUiAssignable sets UiAssignable field to given value. + +### HasUiAssignable + +`func (o *RightSetDTO) HasUiAssignable() bool` + +HasUiAssignable returns a boolean if a field has been set. + +### GetTranslatedName + +`func (o *RightSetDTO) GetTranslatedName() string` + +GetTranslatedName returns the TranslatedName field if non-nil, zero value otherwise. + +### GetTranslatedNameOk + +`func (o *RightSetDTO) GetTranslatedNameOk() (*string, bool)` + +GetTranslatedNameOk returns a tuple with the TranslatedName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTranslatedName + +`func (o *RightSetDTO) SetTranslatedName(v string)` + +SetTranslatedName sets TranslatedName field to given value. + +### HasTranslatedName + +`func (o *RightSetDTO) HasTranslatedName() bool` + +HasTranslatedName returns a boolean if a field has been set. + +### GetTranslatedDescription + +`func (o *RightSetDTO) GetTranslatedDescription() string` + +GetTranslatedDescription returns the TranslatedDescription field if non-nil, zero value otherwise. + +### GetTranslatedDescriptionOk + +`func (o *RightSetDTO) GetTranslatedDescriptionOk() (*string, bool)` + +GetTranslatedDescriptionOk returns a tuple with the TranslatedDescription field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTranslatedDescription + +`func (o *RightSetDTO) SetTranslatedDescription(v string)` + +SetTranslatedDescription sets TranslatedDescription field to given value. + +### HasTranslatedDescription + +`func (o *RightSetDTO) HasTranslatedDescription() bool` + +HasTranslatedDescription returns a boolean if a field has been set. + +### SetTranslatedDescriptionNil + +`func (o *RightSetDTO) SetTranslatedDescriptionNil(b bool)` + + SetTranslatedDescriptionNil sets the value for TranslatedDescription to be an explicit nil + +### UnsetTranslatedDescription +`func (o *RightSetDTO) UnsetTranslatedDescription()` + +UnsetTranslatedDescription ensures that no value is present for TranslatedDescription, not even an explicit nil +### GetParentId + +`func (o *RightSetDTO) GetParentId() string` + +GetParentId returns the ParentId field if non-nil, zero value otherwise. + +### GetParentIdOk + +`func (o *RightSetDTO) 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 *RightSetDTO) SetParentId(v string)` + +SetParentId sets ParentId field to given value. + +### HasParentId + +`func (o *RightSetDTO) HasParentId() bool` + +HasParentId returns a boolean if a field has been set. + +### SetParentIdNil + +`func (o *RightSetDTO) SetParentIdNil(b bool)` + + SetParentIdNil sets the value for ParentId to be an explicit nil + +### UnsetParentId +`func (o *RightSetDTO) 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/UserLevelPublishSummary.md b/docs/tools/sdk/go/Reference/V2025/Models/UserLevelPublishSummary.md new file mode 100644 index 000000000..0db03a5a7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/UserLevelPublishSummary.md @@ -0,0 +1,142 @@ +--- +id: v2025-user-level-publish-summary +title: UserLevelPublishSummary +pagination_label: UserLevelPublishSummary +sidebar_label: UserLevelPublishSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UserLevelPublishSummary', 'V2025UserLevelPublishSummary'] +slug: /tools/sdk/go/v2025/models/user-level-publish-summary +tags: ['SDK', 'Software Development Kit', 'UserLevelPublishSummary', 'V2025UserLevelPublishSummary'] +--- + +# UserLevelPublishSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserLevelId** | Pointer to **string** | The unique identifier of the UserLevel. | [optional] +**Publish** | Pointer to **bool** | Indicates whether the API call triggered a publish operation. | [optional] [default to false] +**Status** | Pointer to **string** | The status of the UserLevel publish operation. | [optional] +**Modified** | Pointer to **SailPointTime** | The last modification timestamp of the UserLevel. | [optional] + +## Methods + +### NewUserLevelPublishSummary + +`func NewUserLevelPublishSummary() *UserLevelPublishSummary` + +NewUserLevelPublishSummary instantiates a new UserLevelPublishSummary object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUserLevelPublishSummaryWithDefaults + +`func NewUserLevelPublishSummaryWithDefaults() *UserLevelPublishSummary` + +NewUserLevelPublishSummaryWithDefaults instantiates a new UserLevelPublishSummary object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetUserLevelId + +`func (o *UserLevelPublishSummary) GetUserLevelId() string` + +GetUserLevelId returns the UserLevelId field if non-nil, zero value otherwise. + +### GetUserLevelIdOk + +`func (o *UserLevelPublishSummary) GetUserLevelIdOk() (*string, bool)` + +GetUserLevelIdOk returns a tuple with the UserLevelId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserLevelId + +`func (o *UserLevelPublishSummary) SetUserLevelId(v string)` + +SetUserLevelId sets UserLevelId field to given value. + +### HasUserLevelId + +`func (o *UserLevelPublishSummary) HasUserLevelId() bool` + +HasUserLevelId returns a boolean if a field has been set. + +### GetPublish + +`func (o *UserLevelPublishSummary) GetPublish() bool` + +GetPublish returns the Publish field if non-nil, zero value otherwise. + +### GetPublishOk + +`func (o *UserLevelPublishSummary) GetPublishOk() (*bool, bool)` + +GetPublishOk returns a tuple with the Publish field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublish + +`func (o *UserLevelPublishSummary) SetPublish(v bool)` + +SetPublish sets Publish field to given value. + +### HasPublish + +`func (o *UserLevelPublishSummary) HasPublish() bool` + +HasPublish returns a boolean if a field has been set. + +### GetStatus + +`func (o *UserLevelPublishSummary) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *UserLevelPublishSummary) 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 *UserLevelPublishSummary) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *UserLevelPublishSummary) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetModified + +`func (o *UserLevelPublishSummary) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *UserLevelPublishSummary) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *UserLevelPublishSummary) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *UserLevelPublishSummary) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/UserLevelRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/UserLevelRequest.md new file mode 100644 index 000000000..3d63ed7bc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/UserLevelRequest.md @@ -0,0 +1,127 @@ +--- +id: v2025-user-level-request +title: UserLevelRequest +pagination_label: UserLevelRequest +sidebar_label: UserLevelRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UserLevelRequest', 'V2025UserLevelRequest'] +slug: /tools/sdk/go/v2025/models/user-level-request +tags: ['SDK', 'Software Development Kit', 'UserLevelRequest', 'V2025UserLevelRequest'] +--- + +# UserLevelRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The name of the user level. | +**Description** | **string** | A brief description of the user level. | +**Owner** | [**BaseReferenceDto**](base-reference-dto) | | +**RightSets** | Pointer to **[]string** | A list of rights associated with the user level. | [optional] + +## Methods + +### NewUserLevelRequest + +`func NewUserLevelRequest(name string, description string, owner BaseReferenceDto, ) *UserLevelRequest` + +NewUserLevelRequest instantiates a new UserLevelRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUserLevelRequestWithDefaults + +`func NewUserLevelRequestWithDefaults() *UserLevelRequest` + +NewUserLevelRequestWithDefaults instantiates a new UserLevelRequest object +This 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 *UserLevelRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *UserLevelRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *UserLevelRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *UserLevelRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *UserLevelRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *UserLevelRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetOwner + +`func (o *UserLevelRequest) GetOwner() BaseReferenceDto` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *UserLevelRequest) 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 *UserLevelRequest) SetOwner(v BaseReferenceDto)` + +SetOwner sets Owner field to given value. + + +### GetRightSets + +`func (o *UserLevelRequest) GetRightSets() []string` + +GetRightSets returns the RightSets field if non-nil, zero value otherwise. + +### GetRightSetsOk + +`func (o *UserLevelRequest) GetRightSetsOk() (*[]string, bool)` + +GetRightSetsOk returns a tuple with the RightSets field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRightSets + +`func (o *UserLevelRequest) SetRightSets(v []string)` + +SetRightSets sets RightSets field to given value. + +### HasRightSets + +`func (o *UserLevelRequest) HasRightSets() bool` + +HasRightSets returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/UserLevelSummaryDTO.md b/docs/tools/sdk/go/Reference/V2025/Models/UserLevelSummaryDTO.md new file mode 100644 index 000000000..37a51f226 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/UserLevelSummaryDTO.md @@ -0,0 +1,488 @@ +--- +id: v2025-user-level-summary-dto +title: UserLevelSummaryDTO +pagination_label: UserLevelSummaryDTO +sidebar_label: UserLevelSummaryDTO +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UserLevelSummaryDTO', 'V2025UserLevelSummaryDTO'] +slug: /tools/sdk/go/v2025/models/user-level-summary-dto +tags: ['SDK', 'Software Development Kit', 'UserLevelSummaryDTO', 'V2025UserLevelSummaryDTO'] +--- + +# UserLevelSummaryDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique identifier of the UserLevel. | [optional] +**Name** | Pointer to **string** | The human-readable name of the UserLevel. | [optional] +**Description** | Pointer to **NullableString** | A human-readable description of the UserLevel. | [optional] +**LegacyGroup** | Pointer to **NullableString** | The legacy group associated with the UserLevel, used for backward compatibility for the UserLevel id. | [optional] +**RightSets** | Pointer to [**[]RightSetDTO**](right-set-dto) | List of RightSets associated with the UserLevel. | [optional] +**Custom** | Pointer to **bool** | Indicates whether the UserLevel is custom. | [optional] [default to true] +**AdminAssignable** | Pointer to **bool** | Indicates whether the UserLevel is admin-assignable. | [optional] [default to true] +**TranslatedName** | Pointer to **NullableString** | The translated name of the UserLevel. | [optional] +**TranslatedGrant** | Pointer to **NullableString** | The translated grant message for the UserLevel. | [optional] +**TranslatedRemove** | Pointer to **NullableString** | The translated remove message for the UserLevel. | [optional] +**Owner** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional] +**Status** | Pointer to **string** | The status of the UserLevel. | [optional] +**Created** | Pointer to **SailPointTime** | The creation timestamp of the UserLevel. | [optional] +**Modified** | Pointer to **SailPointTime** | The last modification timestamp of the UserLevel. | [optional] +**AssociatedIdentitiesCount** | Pointer to **NullableInt32** | The count of associated identities for the UserLevel. | [optional] + +## Methods + +### NewUserLevelSummaryDTO + +`func NewUserLevelSummaryDTO() *UserLevelSummaryDTO` + +NewUserLevelSummaryDTO instantiates a new UserLevelSummaryDTO object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUserLevelSummaryDTOWithDefaults + +`func NewUserLevelSummaryDTOWithDefaults() *UserLevelSummaryDTO` + +NewUserLevelSummaryDTOWithDefaults instantiates a new UserLevelSummaryDTO object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *UserLevelSummaryDTO) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *UserLevelSummaryDTO) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *UserLevelSummaryDTO) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *UserLevelSummaryDTO) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *UserLevelSummaryDTO) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *UserLevelSummaryDTO) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *UserLevelSummaryDTO) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *UserLevelSummaryDTO) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *UserLevelSummaryDTO) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *UserLevelSummaryDTO) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *UserLevelSummaryDTO) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *UserLevelSummaryDTO) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *UserLevelSummaryDTO) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *UserLevelSummaryDTO) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetLegacyGroup + +`func (o *UserLevelSummaryDTO) GetLegacyGroup() string` + +GetLegacyGroup returns the LegacyGroup field if non-nil, zero value otherwise. + +### GetLegacyGroupOk + +`func (o *UserLevelSummaryDTO) GetLegacyGroupOk() (*string, bool)` + +GetLegacyGroupOk returns a tuple with the LegacyGroup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLegacyGroup + +`func (o *UserLevelSummaryDTO) SetLegacyGroup(v string)` + +SetLegacyGroup sets LegacyGroup field to given value. + +### HasLegacyGroup + +`func (o *UserLevelSummaryDTO) HasLegacyGroup() bool` + +HasLegacyGroup returns a boolean if a field has been set. + +### SetLegacyGroupNil + +`func (o *UserLevelSummaryDTO) SetLegacyGroupNil(b bool)` + + SetLegacyGroupNil sets the value for LegacyGroup to be an explicit nil + +### UnsetLegacyGroup +`func (o *UserLevelSummaryDTO) UnsetLegacyGroup()` + +UnsetLegacyGroup ensures that no value is present for LegacyGroup, not even an explicit nil +### GetRightSets + +`func (o *UserLevelSummaryDTO) GetRightSets() []RightSetDTO` + +GetRightSets returns the RightSets field if non-nil, zero value otherwise. + +### GetRightSetsOk + +`func (o *UserLevelSummaryDTO) GetRightSetsOk() (*[]RightSetDTO, bool)` + +GetRightSetsOk returns a tuple with the RightSets field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRightSets + +`func (o *UserLevelSummaryDTO) SetRightSets(v []RightSetDTO)` + +SetRightSets sets RightSets field to given value. + +### HasRightSets + +`func (o *UserLevelSummaryDTO) HasRightSets() bool` + +HasRightSets returns a boolean if a field has been set. + +### GetCustom + +`func (o *UserLevelSummaryDTO) GetCustom() bool` + +GetCustom returns the Custom field if non-nil, zero value otherwise. + +### GetCustomOk + +`func (o *UserLevelSummaryDTO) GetCustomOk() (*bool, bool)` + +GetCustomOk returns a tuple with the Custom field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCustom + +`func (o *UserLevelSummaryDTO) SetCustom(v bool)` + +SetCustom sets Custom field to given value. + +### HasCustom + +`func (o *UserLevelSummaryDTO) HasCustom() bool` + +HasCustom returns a boolean if a field has been set. + +### GetAdminAssignable + +`func (o *UserLevelSummaryDTO) GetAdminAssignable() bool` + +GetAdminAssignable returns the AdminAssignable field if non-nil, zero value otherwise. + +### GetAdminAssignableOk + +`func (o *UserLevelSummaryDTO) GetAdminAssignableOk() (*bool, bool)` + +GetAdminAssignableOk returns a tuple with the AdminAssignable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAdminAssignable + +`func (o *UserLevelSummaryDTO) SetAdminAssignable(v bool)` + +SetAdminAssignable sets AdminAssignable field to given value. + +### HasAdminAssignable + +`func (o *UserLevelSummaryDTO) HasAdminAssignable() bool` + +HasAdminAssignable returns a boolean if a field has been set. + +### GetTranslatedName + +`func (o *UserLevelSummaryDTO) GetTranslatedName() string` + +GetTranslatedName returns the TranslatedName field if non-nil, zero value otherwise. + +### GetTranslatedNameOk + +`func (o *UserLevelSummaryDTO) GetTranslatedNameOk() (*string, bool)` + +GetTranslatedNameOk returns a tuple with the TranslatedName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTranslatedName + +`func (o *UserLevelSummaryDTO) SetTranslatedName(v string)` + +SetTranslatedName sets TranslatedName field to given value. + +### HasTranslatedName + +`func (o *UserLevelSummaryDTO) HasTranslatedName() bool` + +HasTranslatedName returns a boolean if a field has been set. + +### SetTranslatedNameNil + +`func (o *UserLevelSummaryDTO) SetTranslatedNameNil(b bool)` + + SetTranslatedNameNil sets the value for TranslatedName to be an explicit nil + +### UnsetTranslatedName +`func (o *UserLevelSummaryDTO) UnsetTranslatedName()` + +UnsetTranslatedName ensures that no value is present for TranslatedName, not even an explicit nil +### GetTranslatedGrant + +`func (o *UserLevelSummaryDTO) GetTranslatedGrant() string` + +GetTranslatedGrant returns the TranslatedGrant field if non-nil, zero value otherwise. + +### GetTranslatedGrantOk + +`func (o *UserLevelSummaryDTO) GetTranslatedGrantOk() (*string, bool)` + +GetTranslatedGrantOk returns a tuple with the TranslatedGrant field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTranslatedGrant + +`func (o *UserLevelSummaryDTO) SetTranslatedGrant(v string)` + +SetTranslatedGrant sets TranslatedGrant field to given value. + +### HasTranslatedGrant + +`func (o *UserLevelSummaryDTO) HasTranslatedGrant() bool` + +HasTranslatedGrant returns a boolean if a field has been set. + +### SetTranslatedGrantNil + +`func (o *UserLevelSummaryDTO) SetTranslatedGrantNil(b bool)` + + SetTranslatedGrantNil sets the value for TranslatedGrant to be an explicit nil + +### UnsetTranslatedGrant +`func (o *UserLevelSummaryDTO) UnsetTranslatedGrant()` + +UnsetTranslatedGrant ensures that no value is present for TranslatedGrant, not even an explicit nil +### GetTranslatedRemove + +`func (o *UserLevelSummaryDTO) GetTranslatedRemove() string` + +GetTranslatedRemove returns the TranslatedRemove field if non-nil, zero value otherwise. + +### GetTranslatedRemoveOk + +`func (o *UserLevelSummaryDTO) GetTranslatedRemoveOk() (*string, bool)` + +GetTranslatedRemoveOk returns a tuple with the TranslatedRemove field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTranslatedRemove + +`func (o *UserLevelSummaryDTO) SetTranslatedRemove(v string)` + +SetTranslatedRemove sets TranslatedRemove field to given value. + +### HasTranslatedRemove + +`func (o *UserLevelSummaryDTO) HasTranslatedRemove() bool` + +HasTranslatedRemove returns a boolean if a field has been set. + +### SetTranslatedRemoveNil + +`func (o *UserLevelSummaryDTO) SetTranslatedRemoveNil(b bool)` + + SetTranslatedRemoveNil sets the value for TranslatedRemove to be an explicit nil + +### UnsetTranslatedRemove +`func (o *UserLevelSummaryDTO) UnsetTranslatedRemove()` + +UnsetTranslatedRemove ensures that no value is present for TranslatedRemove, not even an explicit nil +### GetOwner + +`func (o *UserLevelSummaryDTO) GetOwner() BaseReferenceDto` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *UserLevelSummaryDTO) 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 *UserLevelSummaryDTO) SetOwner(v BaseReferenceDto)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *UserLevelSummaryDTO) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetStatus + +`func (o *UserLevelSummaryDTO) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *UserLevelSummaryDTO) 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 *UserLevelSummaryDTO) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *UserLevelSummaryDTO) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetCreated + +`func (o *UserLevelSummaryDTO) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *UserLevelSummaryDTO) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *UserLevelSummaryDTO) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *UserLevelSummaryDTO) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *UserLevelSummaryDTO) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *UserLevelSummaryDTO) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *UserLevelSummaryDTO) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *UserLevelSummaryDTO) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetAssociatedIdentitiesCount + +`func (o *UserLevelSummaryDTO) GetAssociatedIdentitiesCount() int32` + +GetAssociatedIdentitiesCount returns the AssociatedIdentitiesCount field if non-nil, zero value otherwise. + +### GetAssociatedIdentitiesCountOk + +`func (o *UserLevelSummaryDTO) GetAssociatedIdentitiesCountOk() (*int32, bool)` + +GetAssociatedIdentitiesCountOk returns a tuple with the AssociatedIdentitiesCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssociatedIdentitiesCount + +`func (o *UserLevelSummaryDTO) SetAssociatedIdentitiesCount(v int32)` + +SetAssociatedIdentitiesCount sets AssociatedIdentitiesCount field to given value. + +### HasAssociatedIdentitiesCount + +`func (o *UserLevelSummaryDTO) HasAssociatedIdentitiesCount() bool` + +HasAssociatedIdentitiesCount returns a boolean if a field has been set. + +### SetAssociatedIdentitiesCountNil + +`func (o *UserLevelSummaryDTO) SetAssociatedIdentitiesCountNil(b bool)` + + SetAssociatedIdentitiesCountNil sets the value for AssociatedIdentitiesCount to be an explicit nil + +### UnsetAssociatedIdentitiesCount +`func (o *UserLevelSummaryDTO) UnsetAssociatedIdentitiesCount()` + +UnsetAssociatedIdentitiesCount ensures that no value is present for AssociatedIdentitiesCount, not even an explicit nil + diff --git a/static/code-examples/v2025/go_code_examples_overlay.yaml b/static/code-examples/v2025/go_code_examples_overlay.yaml index 0cc0bcc2a..494f67b22 100644 --- a/static/code-examples/v2025/go_code_examples_overlay.yaml +++ b/static/code-examples/v2025/go_code_examples_overlay.yaml @@ -8038,6 +8038,288 @@ // response from `GetCustomPasswordInstructions`: CustomPasswordInstruction fmt.Fprintf(os.Stdout, "Response from `CustomPasswordInstructionsAPI.GetCustomPasswordInstructions`: %v\n", resp) } +- path: /authorization/custom-user-levels + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/custom-user-levels#create-custom-user-level + source: | + package main + + import ( + "context" + "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") + userlevelrequest := []byte(`{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "rightSets" : [ "idn:ui-right-set-list-read-example", "idn:ui-right-set-write-example" ], + "name" : "Custom User Level Name", + "description" : "This is a description of the custom user level." + }`) // UserLevelRequest | Payload containing the details of the user level to be created. + + + var userLevelRequest v2025.UserLevelRequest + if err := json.Unmarshal(userlevelrequest, &userLevelRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomUserLevelsAPI.CreateCustomUserLevel(context.Background()).XSailPointExperimental(xSailPointExperimental).UserLevelRequest(userLevelRequest).Execute() + //resp, r, err := apiClient.V2025.CustomUserLevelsAPI.CreateCustomUserLevel(context.Background()).XSailPointExperimental(xSailPointExperimental).UserLevelRequest(userLevelRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomUserLevelsAPI.CreateCustomUserLevel``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCustomUserLevel`: UserLevelSummaryDTO + fmt.Fprintf(os.Stdout, "Response from `CustomUserLevelsAPI.CreateCustomUserLevel`: %v\n", resp) + } +- path: /authorization/custom-user-levels/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/custom-user-levels#delete-user-level + source: | + package main + + import ( + "context" + "fmt" + "os" + + 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 := `6e110911-5984-491b-be74-2707980a46a7` // string | The unique identifier of the user level. # string | The unique identifier of the user level. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.CustomUserLevelsAPI.DeleteUserLevel(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.CustomUserLevelsAPI.DeleteUserLevel(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomUserLevelsAPI.DeleteUserLevel``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /authorization/custom-user-levels/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/custom-user-levels#get-user-level + source: | + package main + + import ( + "context" + "fmt" + "os" + + 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 := `6e110911-5984-491b-be74-2707980a46a7` // string | The unique identifier of the user level. # string | The unique identifier of the user level. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomUserLevelsAPI.GetUserLevel(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.CustomUserLevelsAPI.GetUserLevel(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomUserLevelsAPI.GetUserLevel``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetUserLevel`: UserLevelSummaryDTO + fmt.Fprintf(os.Stdout, "Response from `CustomUserLevelsAPI.GetUserLevel`: %v\n", resp) + } +- path: /authorization/authorization-assignable-right-sets + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/custom-user-levels#list-all-authorization-right-sets + source: | + package main + + import ( + "context" + "fmt" + "os" + + 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 := `category eq "identity"` // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **category**: *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: **category**: *eq* (optional) + sorters := `name, -id, -category` // string | Sort results using the standard syntax described 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, category** (optional) # string | Sort results using the standard syntax described 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, category** (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.CustomUserLevelsAPI.ListAllAuthorizationRightSets(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.CustomUserLevelsAPI.ListAllAuthorizationRightSets(context.Background()).XSailPointExperimental(xSailPointExperimental).Filters(filters).Sorters(sorters).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomUserLevelsAPI.ListAllAuthorizationRightSets``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAllAuthorizationRightSets`: []HierarchicalRightSet + fmt.Fprintf(os.Stdout, "Response from `CustomUserLevelsAPI.ListAllAuthorizationRightSets`: %v\n", resp) + } +- path: /authorization/custom-user-levels + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/custom-user-levels#list-user-levels + source: | + package main + + import ( + "context" + "fmt" + "os" + + 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") + detailLevel := `detailLevel=FULL` // string | Specifies the level of detail for the user levels. (optional) # string | Specifies the level of detail for the user levels. (optional) + filters := `name co "identity", owner co "john", status eq "active"` // string | Filter results using the standard syntax described in [V3 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**: *co* **owner**: *co* **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: **name**: *co* **owner**: *co* **status**: *eq* (optional) + 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** (optional) # string | Sort results using the standard syntax described in [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) + limit := 250 // int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset := 0 // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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.CustomUserLevelsAPI.ListUserLevels(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.CustomUserLevelsAPI.ListUserLevels(context.Background()).XSailPointExperimental(xSailPointExperimental).DetailLevel(detailLevel).Filters(filters).Sorters(sorters).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomUserLevelsAPI.ListUserLevels``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListUserLevels`: []UserLevelSummaryDTO + fmt.Fprintf(os.Stdout, "Response from `CustomUserLevelsAPI.ListUserLevels`: %v\n", resp) + } +- path: /authorization/custom-user-levels/{id}/publish + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/custom-user-levels#publish-custom-user-level + source: | + package main + + import ( + "context" + "fmt" + "os" + + 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 := `6e110911-5984-491b-be74-2707980a46a7` // string | The unique identifier of the user level to publish. # string | The unique identifier of the user level to publish. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomUserLevelsAPI.PublishCustomUserLevel(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.CustomUserLevelsAPI.PublishCustomUserLevel(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomUserLevelsAPI.PublishCustomUserLevel``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PublishCustomUserLevel`: UserLevelPublishSummary + fmt.Fprintf(os.Stdout, "Response from `CustomUserLevelsAPI.PublishCustomUserLevel`: %v\n", resp) + } +- path: /authorization/custom-user-levels/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/custom-user-levels#update-user-level + source: | + package main + + import ( + "context" + "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 := `6e110911-5984-491b-be74-2707980a46a7` // string | The unique identifier of the user level. # string | The unique identifier of the user level. + jsonpatch := []byte(`{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }`) // JsonPatch | JSON Patch payload for updating the user level. + + + 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.CustomUserLevelsAPI.UpdateUserLevel(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatch(jsonPatch).Execute() + //resp, r, err := apiClient.V2025.CustomUserLevelsAPI.UpdateUserLevel(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatch(jsonPatch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomUserLevelsAPI.UpdateUserLevel``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateUserLevel`: UserLevelSummaryDTO + fmt.Fprintf(os.Stdout, "Response from `CustomUserLevelsAPI.UpdateUserLevel`: %v\n", resp) + } - path: /data-segments method: Post xCodeSample: