Skip to content

Latest commit

 

History

History
219 lines (138 loc) · 7.15 KB

CustomPasswordInstructionsApi.md

File metadata and controls

219 lines (138 loc) · 7.15 KB
Raw

\CustomPasswordInstructionsApi

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

Method HTTP request Description
CreateCustomPasswordInstructions Post /custom-password-instructions Create Custom Password Instructions
DeleteCustomPasswordInstructions Delete /custom-password-instructions/{pageId} Delete Custom Password Instructions by page ID
GetCustomPasswordInstructions Get /custom-password-instructions/{pageId} Get Custom Password Instructions by Page ID

CreateCustomPasswordInstructions

CustomPasswordInstruction CreateCustomPasswordInstructions(ctx).CustomPasswordInstruction(customPasswordInstruction).Execute()

Create Custom Password Instructions

Example

package main

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

func main() {
    customPasswordInstruction := *openapiclient.NewCustomPasswordInstruction() // CustomPasswordInstruction | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
customPasswordInstruction CustomPasswordInstruction

Return type

CustomPasswordInstruction

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]

DeleteCustomPasswordInstructions

DeleteCustomPasswordInstructions(ctx, pageId).Locale(locale).Execute()

Delete Custom Password Instructions by page ID

Example

package main

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

func main() {
    pageId := "mfa:select" // string | The page ID of custom password instructions to delete.
    locale := "locale_example" // string | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional)

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
pageId string The page ID of custom password instructions to delete.

Other Parameters

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

Name Type Description Notes

locale | string | The locale for the custom instructions, a BCP47 language tag. The default value is \"default\". |

Return type

(empty response body)

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]

GetCustomPasswordInstructions

CustomPasswordInstruction GetCustomPasswordInstructions(ctx, pageId).Locale(locale).Execute()

Get Custom Password Instructions by Page ID

Example

package main

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

func main() {
    pageId := "mfa:select" // string | The page ID of custom password instructions to query.
    locale := "locale_example" // string | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional)

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
pageId string The page ID of custom password instructions to query.

Other Parameters

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

Name Type Description Notes

locale | string | The locale for the custom instructions, a BCP47 language tag. The default value is \"default\". |

Return type

CustomPasswordInstruction

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]