Skip to content

Latest commit

 

History

History
350 lines (220 loc) · 10.8 KB

SearchAttributeConfigurationApi.md

File metadata and controls

350 lines (220 loc) · 10.8 KB
Raw

\SearchAttributeConfigurationApi

All URIs are relative to https://sailpoint.api.identitynow.com/beta

Method HTTP request Description
CreateSearchAttributeConfig Post /accounts/search-attribute-config Configure/create extended search attributes in IdentityNow.
DeleteSearchAttributeConfig Delete /accounts/search-attribute-config/{name} Delete an extended search attribute in IdentityNow.
GetSearchAttributeConfig Get /accounts/search-attribute-config Retrieve a list of extended search attributes in IdentityNow.
GetSingleSearchAttributeConfig Get /accounts/search-attribute-config/{name} Get the details of a specific extended search attribute in IdentityNow.
PatchSearchAttributeConfig Patch /accounts/search-attribute-config/{name} Update the details of a specific extended search attribute in IdentityNow.

CreateSearchAttributeConfig

map[string]interface{} CreateSearchAttributeConfig(ctx).SearchAttributeConfig(searchAttributeConfig).Execute()

Configure/create extended search attributes in IdentityNow.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    searchAttributeConfig := *openapiclient.NewSearchAttributeConfig() // SearchAttributeConfig | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SearchAttributeConfigurationApi.CreateSearchAttributeConfig(context.Background()).SearchAttributeConfig(searchAttributeConfig).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationApi.CreateSearchAttributeConfig``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateSearchAttributeConfig`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationApi.CreateSearchAttributeConfig`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCreateSearchAttributeConfigRequest struct via the builder pattern

Name Type Description Notes
searchAttributeConfig SearchAttributeConfig

Return type

map[string]interface{}

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteSearchAttributeConfig

DeleteSearchAttributeConfig(ctx, name).Execute()

Delete an extended search attribute in IdentityNow.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    name := "newMailAttribute" // string | Name of the extended search attribute configuration to delete.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SearchAttributeConfigurationApi.DeleteSearchAttributeConfig(context.Background(), name).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationApi.DeleteSearchAttributeConfig``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string Name of the extended search attribute configuration to delete.

Other Parameters

Other parameters are passed through a pointer to a apiDeleteSearchAttributeConfigRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSearchAttributeConfig

[]SearchAttributeConfig GetSearchAttributeConfig(ctx).Execute()

Retrieve a list of extended search attributes in IdentityNow.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SearchAttributeConfigurationApi.GetSearchAttributeConfig(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationApi.GetSearchAttributeConfig``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetSearchAttributeConfig`: []SearchAttributeConfig
    fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationApi.GetSearchAttributeConfig`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetSearchAttributeConfigRequest struct via the builder pattern

Return type

[]SearchAttributeConfig

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSingleSearchAttributeConfig

[]SearchAttributeConfig GetSingleSearchAttributeConfig(ctx, name).Execute()

Get the details of a specific extended search attribute in IdentityNow.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    name := "newMailAttribute" // string | Name of the extended search attribute configuration to delete.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SearchAttributeConfigurationApi.GetSingleSearchAttributeConfig(context.Background(), name).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationApi.GetSingleSearchAttributeConfig``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetSingleSearchAttributeConfig`: []SearchAttributeConfig
    fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationApi.GetSingleSearchAttributeConfig`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string Name of the extended search attribute configuration to delete.

Other Parameters

Other parameters are passed through a pointer to a apiGetSingleSearchAttributeConfigRequest struct via the builder pattern

Name Type Description Notes

Return type

[]SearchAttributeConfig

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchSearchAttributeConfig

SearchAttributeConfig PatchSearchAttributeConfig(ctx, name).JsonPatchOperation(jsonPatchOperation).Execute()

Update the details of a specific extended search attribute in IdentityNow.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    name := "promotedMailAttribute" // string | Name of the Search Attribute Configuration to patch.
    jsonPatchOperation := []openapiclient.JsonPatchOperation{*openapiclient.NewJsonPatchOperation("replace", "/description")} // []JsonPatchOperation | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SearchAttributeConfigurationApi.PatchSearchAttributeConfig(context.Background(), name).JsonPatchOperation(jsonPatchOperation).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationApi.PatchSearchAttributeConfig``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PatchSearchAttributeConfig`: SearchAttributeConfig
    fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationApi.PatchSearchAttributeConfig`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string Name of the Search Attribute Configuration to patch.

Other Parameters

Other parameters are passed through a pointer to a apiPatchSearchAttributeConfigRequest struct via the builder pattern

Name Type Description Notes

jsonPatchOperation | []JsonPatchOperation | |

Return type

SearchAttributeConfig

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

  • Content-Type: application/json-patch+json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]