All URIs are relative to https://sailpoint.api.identitynow.com/beta
Method | HTTP request | Description |
---|---|---|
CreatePotentialRoleProvisionRequest | Post /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision | Create request to provision a potential role into an actual role. |
DownloadRoleMiningPotentialRoleZip | Get /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download | Export (download) details for a potential role in a role mining session |
EditEntitlementsPotentialRole | Post /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements | Edit entitlements for a potential role to exclude some entitlements |
ExportRoleMiningPotentialRole | Get /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export | Export (download) details for a potential role in a role mining session |
ExportRoleMiningPotentialRoleAsync | Post /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async | Asynchronously export details for a potential role in a role mining session and upload to S3 |
ExportRoleMiningPotentialRoleStatus | Get /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId} | Retrieve status of a potential role export job |
GetEntitlementDistributionPotentialRole | Get /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution | Retrieves entitlement popularity distribution for a potential role in a role mining session |
GetEntitlementsPotentialRole | Get /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities | Retrieves entitlements for a potential role in a role mining session |
GetExcludedEntitlementsPotentialRole | Get /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements | Retrieves excluded entitlements for a potential role in a role mining session |
GetIdentitiesPotentialRole | Get /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities | Retrieves identities for a potential role in a role mining session |
GetPotentialRoleApplications | Get /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications | Retrieves the applications of a potential role for a role mining session |
GetPotentialRoleSummaries | Get /role-mining-sessions/{sessionId}/potential-role-summaries | Retrieves the potential role summaries for a role mining session |
GetPotentialRoleSummary | Get /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} | Retrieves a specific potential role for a role mining session |
GetRoleMiningSession | Get /role-mining-sessions/{sessionId} | Get a role mining session |
GetRoleMiningSessionStatus | Get /role-mining-sessions/{sessionId}/status | Get role mining session status state |
GetRoleMiningSessions | Get /role-mining-sessions | Retrieves all role mining sessions |
PatchRoleMiningSession | Patch /role-mining-sessions/{sessionId} | Patch a role mining session |
RoleMiningSessions | Post /role-mining-sessions | Create a role mining session |
RoleMiningPotentialRoleSummary CreatePotentialRoleProvisionRequest(ctx, sessionId, potentialRoleId).MinEntitlementPopularity(minEntitlementPopularity).IncludeCommonAccess(includeCommonAccess).RoleMiningPotentialRoleProvisionRequest(roleMiningPotentialRoleProvisionRequest).Execute()
Create request to provision a potential role into an actual role.
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
sessionId := "8c190e67-87aa-4ed9-a90b-d9d5344523fb" // string | The role mining session id
potentialRoleId := "8c190e67-87aa-4ed9-a90b-d9d5344523fb" // string | A potential role id in a role mining session
minEntitlementPopularity := int32(56) // int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0)
includeCommonAccess := true // bool | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to true)
roleMiningPotentialRoleProvisionRequest := *openapiclient.NewRoleMiningPotentialRoleProvisionRequest() // RoleMiningPotentialRoleProvisionRequest | Required information to create a new role (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.IAIRoleMiningApi.CreatePotentialRoleProvisionRequest(context.Background(), sessionId, potentialRoleId).MinEntitlementPopularity(minEntitlementPopularity).IncludeCommonAccess(includeCommonAccess).RoleMiningPotentialRoleProvisionRequest(roleMiningPotentialRoleProvisionRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningApi.CreatePotentialRoleProvisionRequest``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreatePotentialRoleProvisionRequest`: RoleMiningPotentialRoleSummary
fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningApi.CreatePotentialRoleProvisionRequest`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
sessionId | string | The role mining session id | |
potentialRoleId | string | A potential role id in a role mining session |
Other parameters are passed through a pointer to a apiCreatePotentialRoleProvisionRequestRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
minEntitlementPopularity | int32 | Minimum popularity required for an entitlement to be included in the provisioned role. | [default to 0] includeCommonAccess | bool | Boolean determining whether common access entitlements will be included in the provisioned role. | [default to true] roleMiningPotentialRoleProvisionRequest | RoleMiningPotentialRoleProvisionRequest | Required information to create a new role |
RoleMiningPotentialRoleSummary
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
*os.File DownloadRoleMiningPotentialRoleZip(ctx, sessionId, potentialRoleId, exportId).Execute()
Export (download) details for a potential role in a role mining session
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
sessionId := "8c190e67-87aa-4ed9-a90b-d9d5344523fb" // string | The role mining session id
potentialRoleId := "278359a6-04b7-4669-9468-924cf580964a" // string | A potential role id in a role mining session
exportId := "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" // string | The id of a previously run export job for this potential role
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.IAIRoleMiningApi.DownloadRoleMiningPotentialRoleZip(context.Background(), sessionId, potentialRoleId, exportId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningApi.DownloadRoleMiningPotentialRoleZip``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DownloadRoleMiningPotentialRoleZip`: *os.File
fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningApi.DownloadRoleMiningPotentialRoleZip`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
sessionId | string | The role mining session id | |
potentialRoleId | string | A potential role id in a role mining session | |
exportId | string | The id of a previously run export job for this potential role |
Other parameters are passed through a pointer to a apiDownloadRoleMiningPotentialRoleZipRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
- Content-Type: Not defined
- Accept: application/zip, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RoleMiningPotentialRole EditEntitlementsPotentialRole(ctx, sessionId, potentialRoleId).RoleMiningPotentialRoleEditEntitlements(roleMiningPotentialRoleEditEntitlements).Execute()
Edit entitlements for a potential role to exclude some entitlements
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
sessionId := "8c190e67-87aa-4ed9-a90b-d9d5344523fb" // string | The role mining session id
potentialRoleId := "8c190e67-87aa-4ed9-a90b-d9d5344523fb" // string | A potential role id in a role mining session
roleMiningPotentialRoleEditEntitlements := *openapiclient.NewRoleMiningPotentialRoleEditEntitlements() // RoleMiningPotentialRoleEditEntitlements | Role mining session parameters
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.IAIRoleMiningApi.EditEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).RoleMiningPotentialRoleEditEntitlements(roleMiningPotentialRoleEditEntitlements).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningApi.EditEntitlementsPotentialRole``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `EditEntitlementsPotentialRole`: RoleMiningPotentialRole
fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningApi.EditEntitlementsPotentialRole`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
sessionId | string | The role mining session id | |
potentialRoleId | string | A potential role id in a role mining session |
Other parameters are passed through a pointer to a apiEditEntitlementsPotentialRoleRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
roleMiningPotentialRoleEditEntitlements | RoleMiningPotentialRoleEditEntitlements | Role mining session parameters |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
*os.File ExportRoleMiningPotentialRole(ctx, sessionId, potentialRoleId).Execute()
Export (download) details for a potential role in a role mining session
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
sessionId := "8c190e67-87aa-4ed9-a90b-d9d5344523fb" // string | The role mining session id
potentialRoleId := "8c190e67-87aa-4ed9-a90b-d9d5344523fb" // string | A potential role id in a role mining session
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.IAIRoleMiningApi.ExportRoleMiningPotentialRole(context.Background(), sessionId, potentialRoleId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningApi.ExportRoleMiningPotentialRole``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ExportRoleMiningPotentialRole`: *os.File
fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningApi.ExportRoleMiningPotentialRole`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
sessionId | string | The role mining session id | |
potentialRoleId | string | A potential role id in a role mining session |
Other parameters are passed through a pointer to a apiExportRoleMiningPotentialRoleRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
- Content-Type: Not defined
- Accept: application/zip, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RoleMiningPotentialRoleExportResponse ExportRoleMiningPotentialRoleAsync(ctx, sessionId, potentialRoleId).RoleMiningPotentialRoleExportRequest(roleMiningPotentialRoleExportRequest).Execute()
Asynchronously export details for a potential role in a role mining session and upload to S3
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
sessionId := "8c190e67-87aa-4ed9-a90b-d9d5344523fb" // string | The role mining session id
potentialRoleId := "278359a6-04b7-4669-9468-924cf580964a" // string | A potential role id in a role mining session
roleMiningPotentialRoleExportRequest := *openapiclient.NewRoleMiningPotentialRoleExportRequest() // RoleMiningPotentialRoleExportRequest | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.IAIRoleMiningApi.ExportRoleMiningPotentialRoleAsync(context.Background(), sessionId, potentialRoleId).RoleMiningPotentialRoleExportRequest(roleMiningPotentialRoleExportRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningApi.ExportRoleMiningPotentialRoleAsync``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ExportRoleMiningPotentialRoleAsync`: RoleMiningPotentialRoleExportResponse
fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningApi.ExportRoleMiningPotentialRoleAsync`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
sessionId | string | The role mining session id | |
potentialRoleId | string | A potential role id in a role mining session |
Other parameters are passed through a pointer to a apiExportRoleMiningPotentialRoleAsyncRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
roleMiningPotentialRoleExportRequest | RoleMiningPotentialRoleExportRequest | |
RoleMiningPotentialRoleExportResponse
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RoleMiningPotentialRoleExportResponse ExportRoleMiningPotentialRoleStatus(ctx, sessionId, potentialRoleId, exportId).Execute()
Retrieve status of a potential role export job
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
sessionId := "8c190e67-87aa-4ed9-a90b-d9d5344523fb" // string | The role mining session id
potentialRoleId := "278359a6-04b7-4669-9468-924cf580964a" // string | A potential role id in a role mining session
exportId := "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" // string | The id of a previously run export job for this potential role
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.IAIRoleMiningApi.ExportRoleMiningPotentialRoleStatus(context.Background(), sessionId, potentialRoleId, exportId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningApi.ExportRoleMiningPotentialRoleStatus``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ExportRoleMiningPotentialRoleStatus`: RoleMiningPotentialRoleExportResponse
fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningApi.ExportRoleMiningPotentialRoleStatus`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
sessionId | string | The role mining session id | |
potentialRoleId | string | A potential role id in a role mining session | |
exportId | string | The id of a previously run export job for this potential role |
Other parameters are passed through a pointer to a apiExportRoleMiningPotentialRoleStatusRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
RoleMiningPotentialRoleExportResponse
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]int32 GetEntitlementDistributionPotentialRole(ctx, sessionId, potentialRoleId).IncludeCommonAccess(includeCommonAccess).Execute()
Retrieves entitlement popularity distribution for a potential role in a role mining session
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
sessionId := "8c190e67-87aa-4ed9-a90b-d9d5344523fb" // string | The role mining session id
potentialRoleId := "8c190e67-87aa-4ed9-a90b-d9d5344523fb" // string | A potential role id in a role mining session
includeCommonAccess := true // bool | Boolean determining whether common access entitlements will be included or not (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.IAIRoleMiningApi.GetEntitlementDistributionPotentialRole(context.Background(), sessionId, potentialRoleId).IncludeCommonAccess(includeCommonAccess).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningApi.GetEntitlementDistributionPotentialRole``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetEntitlementDistributionPotentialRole`: map[string]int32
fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningApi.GetEntitlementDistributionPotentialRole`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
sessionId | string | The role mining session id | |
potentialRoleId | string | A potential role id in a role mining session |
Other parameters are passed through a pointer to a apiGetEntitlementDistributionPotentialRoleRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
includeCommonAccess | bool | Boolean determining whether common access entitlements will be included or not |
map[string]int32
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]RoleMiningEntitlement GetEntitlementsPotentialRole(ctx, sessionId, potentialRoleId).IncludeCommonAccess(includeCommonAccess).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute()
Retrieves entitlements for a potential role in a role mining session
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
sessionId := "8c190e67-87aa-4ed9-a90b-d9d5344523fb" // string | The role mining session id
potentialRoleId := "8c190e67-87aa-4ed9-a90b-d9d5344523fb" // string | A potential role id in a role mining session
includeCommonAccess := true // bool | Boolean determining whether common access entitlements will be included or not (optional)
sorters := "sorters_example" // string | sort by popularity, default order descending (optional)
filters := "filters_example" // string | Filter parameter by \"starts with\" for the applicationName and entitlementRef.name. (optional)
offset := int32(0) // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
limit := int32(250) // int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.IAIRoleMiningApi.GetEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).IncludeCommonAccess(includeCommonAccess).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningApi.GetEntitlementsPotentialRole``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetEntitlementsPotentialRole`: []RoleMiningEntitlement
fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningApi.GetEntitlementsPotentialRole`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
sessionId | string | The role mining session id | |
potentialRoleId | string | A potential role id in a role mining session |
Other parameters are passed through a pointer to a apiGetEntitlementsPotentialRoleRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
includeCommonAccess | bool | Boolean determining whether common access entitlements will be included or not | sorters | string | sort by popularity, default order descending | filters | string | Filter parameter by "starts with" for the applicationName and entitlementRef.name. | offset | int32 | Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information. | [default to 0] limit | int32 | Max number of results to return. See V3 API Standard Collection Parameters for more information. | [default to 250] count | bool | If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information. | [default to false]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]RoleMiningEntitlement GetExcludedEntitlementsPotentialRole(ctx, sessionId, potentialRoleId).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute()
Retrieves excluded entitlements for a potential role in a role mining session
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
sessionId := "8c190e67-87aa-4ed9-a90b-d9d5344523fb" // string | The role mining session id
potentialRoleId := "8c190e67-87aa-4ed9-a90b-d9d5344523fb" // string | A potential role id in a role mining session
sorters := "sorters_example" // string | sort by popularity, default order descending (optional)
filters := "filters_example" // string | Filter parameter by \"starts with\" for the applicationName and entitlementRef.name. (optional)
offset := int32(0) // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
limit := int32(250) // int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.IAIRoleMiningApi.GetExcludedEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningApi.GetExcludedEntitlementsPotentialRole``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetExcludedEntitlementsPotentialRole`: []RoleMiningEntitlement
fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningApi.GetExcludedEntitlementsPotentialRole`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
sessionId | string | The role mining session id | |
potentialRoleId | string | A potential role id in a role mining session |
Other parameters are passed through a pointer to a apiGetExcludedEntitlementsPotentialRoleRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
sorters | string | sort by popularity, default order descending | filters | string | Filter parameter by "starts with" for the applicationName and entitlementRef.name. | offset | int32 | Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information. | [default to 0] limit | int32 | Max number of results to return. See V3 API Standard Collection Parameters for more information. | [default to 250] count | bool | If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information. | [default to false]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]RoleMiningIdentity GetIdentitiesPotentialRole(ctx, sessionId, potentialRoleId).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute()
Retrieves identities for a potential role in a role mining session
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
sessionId := "8c190e67-87aa-4ed9-a90b-d9d5344523fb" // string | The role mining session id
potentialRoleId := "8c190e67-87aa-4ed9-a90b-d9d5344523fb" // string | A potential role id in a role mining session
sorters := "sorters_example" // string | sort by name, default order ascending (optional)
filters := "filters_example" // string | Filter parameter by \"starts with\" for the name. (optional)
offset := int32(0) // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
limit := int32(250) // int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.IAIRoleMiningApi.GetIdentitiesPotentialRole(context.Background(), sessionId, potentialRoleId).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningApi.GetIdentitiesPotentialRole``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetIdentitiesPotentialRole`: []RoleMiningIdentity
fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningApi.GetIdentitiesPotentialRole`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
sessionId | string | The role mining session id | |
potentialRoleId | string | A potential role id in a role mining session |
Other parameters are passed through a pointer to a apiGetIdentitiesPotentialRoleRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
sorters | string | sort by name, default order ascending | filters | string | Filter parameter by "starts with" for the name. | offset | int32 | Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information. | [default to 0] limit | int32 | Max number of results to return. See V3 API Standard Collection Parameters for more information. | [default to 250] count | bool | If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information. | [default to false]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]RoleMiningPotentialRoleApplication GetPotentialRoleApplications(ctx, sessionId, potentialRoleId).Offset(offset).Limit(limit).Count(count).Execute()
Retrieves the applications of a potential role for a role mining session
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
sessionId := "8c190e67-87aa-4ed9-a90b-d9d5344523fb" // string | The role mining session id
potentialRoleId := "8c190e67-87aa-4ed9-a90b-d9d5344523fb" // string | A potential role id in a role mining session
offset := int32(0) // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
limit := int32(250) // int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.IAIRoleMiningApi.GetPotentialRoleApplications(context.Background(), sessionId, potentialRoleId).Offset(offset).Limit(limit).Count(count).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningApi.GetPotentialRoleApplications``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetPotentialRoleApplications`: []RoleMiningPotentialRoleApplication
fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningApi.GetPotentialRoleApplications`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
sessionId | string | The role mining session id | |
potentialRoleId | string | A potential role id in a role mining session |
Other parameters are passed through a pointer to a apiGetPotentialRoleApplicationsRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
offset | int32 | Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information. | [default to 0] limit | int32 | Max number of results to return. See V3 API Standard Collection Parameters for more information. | [default to 250] count | bool | If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information. | [default to false]
[]RoleMiningPotentialRoleApplication
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]RoleMiningPotentialRoleSummary GetPotentialRoleSummaries(ctx, sessionId).Sorters(sorters).Offset(offset).Limit(limit).Count(count).Execute()
Retrieves the potential role summaries for a role mining session
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
sessionId := "8c190e67-87aa-4ed9-a90b-d9d5344523fb" // string | The role mining session id
sorters := "sorters_example" // string | sort by identityCount, density, freshness or quality (optional)
offset := int32(0) // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
limit := int32(250) // int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.IAIRoleMiningApi.GetPotentialRoleSummaries(context.Background(), sessionId).Sorters(sorters).Offset(offset).Limit(limit).Count(count).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningApi.GetPotentialRoleSummaries``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetPotentialRoleSummaries`: []RoleMiningPotentialRoleSummary
fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningApi.GetPotentialRoleSummaries`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
sessionId | string | The role mining session id |
Other parameters are passed through a pointer to a apiGetPotentialRoleSummariesRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
sorters | string | sort by identityCount, density, freshness or quality | offset | int32 | Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information. | [default to 0] limit | int32 | Max number of results to return. See V3 API Standard Collection Parameters for more information. | [default to 250] count | bool | If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information. | [default to false]
[]RoleMiningPotentialRoleSummary
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RoleMiningPotentialRoleSummaryDistribution GetPotentialRoleSummary(ctx, sessionId, potentialRoleId).Execute()
Retrieves a specific potential role for a role mining session
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
sessionId := "8c190e67-87aa-4ed9-a90b-d9d5344523fb" // string | The role mining session id
potentialRoleId := "8c190e67-87aa-4ed9-a90b-d9d5344523fb" // string | A potential role id in a role mining session
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.IAIRoleMiningApi.GetPotentialRoleSummary(context.Background(), sessionId, potentialRoleId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningApi.GetPotentialRoleSummary``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetPotentialRoleSummary`: RoleMiningPotentialRoleSummaryDistribution
fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningApi.GetPotentialRoleSummary`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
sessionId | string | The role mining session id | |
potentialRoleId | string | A potential role id in a role mining session |
Other parameters are passed through a pointer to a apiGetPotentialRoleSummaryRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
RoleMiningPotentialRoleSummaryDistribution
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RoleMiningSessionResponse GetRoleMiningSession(ctx, sessionId).Execute()
Get a role mining session
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
sessionId := "8c190e67-87aa-4ed9-a90b-d9d5344523fb" // string | The role mining session id to be retrieved.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.IAIRoleMiningApi.GetRoleMiningSession(context.Background(), sessionId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningApi.GetRoleMiningSession``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetRoleMiningSession`: RoleMiningSessionResponse
fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningApi.GetRoleMiningSession`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
sessionId | string | The role mining session id to be retrieved. |
Other parameters are passed through a pointer to a apiGetRoleMiningSessionRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RoleMiningSessionStatus GetRoleMiningSessionStatus(ctx, sessionId).Execute()
Get role mining session status state
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
sessionId := "8c190e67-87aa-4ed9-a90b-d9d5344523fb" // string | The role mining session id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.IAIRoleMiningApi.GetRoleMiningSessionStatus(context.Background(), sessionId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningApi.GetRoleMiningSessionStatus``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetRoleMiningSessionStatus`: RoleMiningSessionStatus
fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningApi.GetRoleMiningSessionStatus`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
sessionId | string | The role mining session id |
Other parameters are passed through a pointer to a apiGetRoleMiningSessionStatusRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]RoleMiningSessionDto GetRoleMiningSessions(ctx).Filters(filters).Sorters(sorters).Offset(offset).Limit(limit).Count(count).Execute()
Retrieves all role mining sessions
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
filters := "saved eq "true" and name sw "RM Session"" // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **saved**: *eq* \"true\" or \"false\" **name**: *eq, sw* (optional)
sorters := "createdBy,createdDate" // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdBy, createdDate** (optional)
offset := int32(0) // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
limit := int32(250) // int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.IAIRoleMiningApi.GetRoleMiningSessions(context.Background()).Filters(filters).Sorters(sorters).Offset(offset).Limit(limit).Count(count).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningApi.GetRoleMiningSessions``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetRoleMiningSessions`: []RoleMiningSessionDto
fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningApi.GetRoleMiningSessions`: %v\n", resp)
}
Other parameters are passed through a pointer to a apiGetRoleMiningSessionsRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
filters | string | Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: saved: eq "true" or "false" name: eq, sw | |
sorters | string | Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: createdBy, createdDate | |
offset | int32 | Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information. | [default to 0] |
limit | int32 | Max number of results to return. See V3 API Standard Collection Parameters for more information. | [default to 250] |
count | bool | If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information. | [default to false] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} PatchRoleMiningSession(ctx, sessionId).JsonPatchOperation(jsonPatchOperation).Execute()
Patch a role mining session
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
sessionId := "8c190e67-87aa-4ed9-a90b-d9d5344523fb" // string | The role mining session id to be patched
jsonPatchOperation := []openapiclient.JsonPatchOperation{*openapiclient.NewJsonPatchOperation("replace", "/description")} // []JsonPatchOperation | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.IAIRoleMiningApi.PatchRoleMiningSession(context.Background(), sessionId).JsonPatchOperation(jsonPatchOperation).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningApi.PatchRoleMiningSession``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `PatchRoleMiningSession`: map[string]interface{}
fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningApi.PatchRoleMiningSession`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
sessionId | string | The role mining session id to be patched |
Other parameters are passed through a pointer to a apiPatchRoleMiningSessionRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
jsonPatchOperation | []JsonPatchOperation | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. |
map[string]interface{}
- Content-Type: application/json-patch+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RoleMiningSessionResponse RoleMiningSessions(ctx).RoleMiningSessionDto(roleMiningSessionDto).Execute()
Create a role mining session
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
roleMiningSessionDto := *openapiclient.NewRoleMiningSessionDto() // RoleMiningSessionDto | Role mining session parameters
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.IAIRoleMiningApi.RoleMiningSessions(context.Background()).RoleMiningSessionDto(roleMiningSessionDto).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningApi.RoleMiningSessions``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `RoleMiningSessions`: RoleMiningSessionResponse
fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningApi.RoleMiningSessions`: %v\n", resp)
}
Other parameters are passed through a pointer to a apiRoleMiningSessionsRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
roleMiningSessionDto | RoleMiningSessionDto | Role mining session parameters |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]