Skip to content

Latest commit

 

History

History
205 lines (129 loc) · 5.51 KB

AuthProfileAPI.md

File metadata and controls

205 lines (129 loc) · 5.51 KB
Raw

\AuthProfileAPI

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

Method HTTP request Description
GetProfileConfig Get /auth-profiles/{id} Get Auth Profile.
GetProfileConfigList Get /auth-profiles Get list of Auth Profiles.
PatchProfileConfig Patch /auth-profiles/{id} Patch a specified Auth Profile

GetProfileConfig

AuthProfile GetProfileConfig(ctx).Execute()

Get Auth Profile.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/sailpoint-oss/golang-sdk/v2"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

AuthProfile

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]

GetProfileConfigList

AuthProfileSummary GetProfileConfigList(ctx).Execute()

Get list of Auth Profiles.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/sailpoint-oss/golang-sdk/v2"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

AuthProfileSummary

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]

PatchProfileConfig

AuthProfile PatchProfileConfig(ctx, id).JsonPatchOperation(jsonPatchOperation).Execute()

Patch a specified Auth Profile

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/sailpoint-oss/golang-sdk/v2"
)

func main() {
    id := "2c91808a7813090a017814121919ecca" // string | ID of the Auth Profile to patch.
    jsonPatchOperation := []openapiclient.JsonPatchOperation{*openapiclient.NewJsonPatchOperation("replace", "/description")} // []JsonPatchOperation | 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID of the Auth Profile to patch.

Other Parameters

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

Name Type Description Notes

jsonPatchOperation | []JsonPatchOperation | |

Return type

AuthProfile

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]