github.com/Axway/agent-sdk@v1.1.101/pkg/apic/provisioning/credentialrequest.go (about)

     1  package provisioning
     2  
     3  import (
     4  	o "github.com/Axway/agent-sdk/pkg/authz/oauth"
     5  )
     6  
     7  // CredentialRequest - interface for agents to use to get necessary credential request details
     8  type CredentialRequest interface {
     9  	// GetApplicationDetailsValue returns a value found on the 'x-agent-details' sub resource of the ManagedApplication.
    10  	GetApplicationDetailsValue(key string) string
    11  	// GetApplicationName returns the name of the managed application for this credential
    12  	GetApplicationName() string
    13  	// GetID returns the ID of the resource for the request
    14  	GetID() string
    15  	// GetName returns the name of the resource for the request
    16  	GetName() string
    17  	// GetCredentialDetailsValue returns a value found on the 'x-agent-details' sub resource of the Credential
    18  	GetCredentialDetailsValue(key string) string
    19  	// GetCredentialType returns the type of credential related to this request
    20  	GetCredentialType() string
    21  	// GetCredentialData returns the map[string]interface{} of data from the request
    22  	GetCredentialData() map[string]interface{}
    23  	// GetCredentialSchema returns the schema for the credential request.
    24  	GetCredentialSchema() map[string]interface{}
    25  	// GetCredentialProvisionSchema returns the provisioning schema for the credential request.
    26  	GetCredentialProvisionSchema() map[string]interface{}
    27  	// GetCredentialSchemaDetails returns a value found on the 'x-agent-details' sub resource of the crd.
    28  	GetCredentialSchemaDetailsValue(key string) interface{}
    29  	// IsIDPCredential returns boolean indicating if the credential request is for IDP provider
    30  	IsIDPCredential() bool
    31  	// GetIDPProvider returns the interface for IDP provider if the credential request is for IDP provider
    32  	GetIDPProvider() o.Provider
    33  	// GetIDPCredentialData returns the credential data for IDP from the request
    34  	GetIDPCredentialData() IDPCredentialData
    35  	// GetCredentialAction returns the action to be handled for this credential
    36  	GetCredentialAction() CredentialAction
    37  	// GetCredentialExpirationDays returns the number of days this credential has to live
    38  	GetCredentialExpirationDays() int
    39  }