\UserCredentialsApi

All URIs are relative to https://api.pingone.com

Method	HTTP request	Description
CreateAUserCredential	Post /environments/{environmentID}/users/{userID}/credentials	Create a User Credential
ReadAllUserCredentials	Get /environments/{environmentID}/users/{userID}/credentials	Read All User Credentials
ReadOneUserCredential	Get /environments/{environmentID}/users/{userID}/credentials/{credentialID}	Read One User Credential
ReadOneUserCredentialWallet	Get /environments/{environmentID}/users/{userID}/credentials/{credentialID}/provisionedCredentials	Read One User Credential Wallet
UpdateAUserCredential	Put /environments/{environmentID}/users/{userID}/credentials/{credentialID}	Update a User Credential

CreateAUserCredential

UserCredential CreateAUserCredential(ctx, environmentID, userID).UserCredential(userCredential).Execute()

Create a User Credential

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/--git-user-id/credentials"
)

func main() {
    environmentID := "environmentID_example" // string | 
    userID := "userID_example" // string | 
    userCredential := *openapiclient.NewUserCredential() // UserCredential |  (optional)

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
environmentID	string
userID	string

Other Parameters

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

Name	Type	Description	Notes

userCredential | UserCredential | |

Return type

UserCredential

Authorization

bearer

HTTP request headers

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

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

ReadAllUserCredentials

EntityArray ReadAllUserCredentials(ctx, environmentID, userID).Execute()

Read All User Credentials

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/--git-user-id/credentials"
)

func main() {
    environmentID := "environmentID_example" // string | 
    userID := "userID_example" // string | 

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
environmentID	string
userID	string

Other Parameters

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

Name	Type	Description	Notes

Return type

EntityArray

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ReadOneUserCredential

UserCredential ReadOneUserCredential(ctx, environmentID, userID, credentialID).Execute()

Read One User Credential

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/--git-user-id/credentials"
)

func main() {
    environmentID := "environmentID_example" // string | 
    userID := "userID_example" // string | 
    credentialID := "credentialID_example" // string | 

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
environmentID	string
userID	string
credentialID	string

Other Parameters

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

Name	Type	Description	Notes

Return type

UserCredential

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ReadOneUserCredentialWallet

EntityArray ReadOneUserCredentialWallet(ctx, environmentID, userID, credentialID).Execute()

Read One User Credential Wallet

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/--git-user-id/credentials"
)

func main() {
    environmentID := "environmentID_example" // string | 
    userID := "userID_example" // string | 
    credentialID := "credentialID_example" // string | 

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
environmentID	string
userID	string
credentialID	string

Other Parameters

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

Name	Type	Description	Notes

Return type

EntityArray

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

UpdateAUserCredential

UserCredential UpdateAUserCredential(ctx, environmentID, userID, credentialID).UserCredential(userCredential).Execute()

Update a User Credential

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/--git-user-id/credentials"
)

func main() {
    environmentID := "environmentID_example" // string | 
    userID := "userID_example" // string | 
    credentialID := "credentialID_example" // string | 
    userCredential := *openapiclient.NewUserCredential() // UserCredential |  (optional)

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
environmentID	string
userID	string
credentialID	string

Other Parameters

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

Name	Type	Description	Notes

userCredential | UserCredential | |

Return type

UserCredential

Authorization

bearer

HTTP request headers

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

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

Files

UserCredentialsApi.md

Latest commit

History

UserCredentialsApi.md

File metadata and controls

\UserCredentialsApi

CreateAUserCredential

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ReadAllUserCredentials

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ReadOneUserCredential

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ReadOneUserCredentialWallet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateAUserCredential

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers