Documentation
¶
Index ¶
- type AppType
- type ApplicationBasicInfoResponseModel
- type ApplicationBasicInfoUpdateModel
- func (c *ApplicationBasicInfoUpdateModel) WithAccessUrl(accessUrl string) *ApplicationBasicInfoUpdateModel
- func (c *ApplicationBasicInfoUpdateModel) WithDescription(description string) *ApplicationBasicInfoUpdateModel
- func (c *ApplicationBasicInfoUpdateModel) WithImageUrl(imageUrl string) *ApplicationBasicInfoUpdateModel
- func (c *ApplicationBasicInfoUpdateModel) WithLogoutReturnUrl(logoutReturnUrl string) *ApplicationBasicInfoUpdateModel
- func (c *ApplicationBasicInfoUpdateModel) WithName(name string) *ApplicationBasicInfoUpdateModel
- type ApplicationClaimConfigurationUpdateModel
- type ApplicationClient
- func (c *ApplicationClient) AuthorizeAPI(ctx context.Context, appID string, apiAuthorization AuthorizedAPICreateModel) error
- func (c *ApplicationClient) CreateM2MApp(ctx context.Context, name string) (*ApplicationBasicInfoResponseModel, error)
- func (c *ApplicationClient) CreateMobileApp(ctx context.Context, name string, redirectURL string) (*ApplicationBasicInfoResponseModel, error)
- func (c *ApplicationClient) CreateSinglePageApp(ctx context.Context, name string, redirectURL string) (*ApplicationBasicInfoResponseModel, error)
- func (c *ApplicationClient) CreateWebAppWithSSR(ctx context.Context, name string, redirectURL string) (*ApplicationBasicInfoResponseModel, error)
- func (c *ApplicationClient) GenerateLoginFlow(ctx context.Context, prompt string) (*LoginFlowGenerateResponseModel, error)
- func (c *ApplicationClient) GetAuthorizedAPIs(ctx context.Context, appID string) (*[]AuthorizedAPIResponseModel, error)
- func (c *ApplicationClient) GetByClienId(ctx context.Context, clientId string) (*ApplicationBasicInfoResponseModel, error)
- func (c *ApplicationClient) GetByName(ctx context.Context, name string) (*ApplicationBasicInfoResponseModel, error)
- func (c *ApplicationClient) GetLoginFlowGenerationResult(ctx context.Context, flowId string) (*LoginFlowResultResponseModel, error)
- func (c *ApplicationClient) GetLoginFlowGenerationStatus(ctx context.Context, flowId string) (*LoginFlowStatusResponseModel, error)
- func (c *ApplicationClient) List(ctx context.Context, limit, offset int) (*ApplicationListResponseModel, error)
- func (c *ApplicationClient) UpdateBasicInfo(ctx context.Context, appId string, updateModel ApplicationBasicInfoUpdateModel) error
- func (c *ApplicationClient) UpdateClaimConfig(ctx context.Context, appId string, ...) error
- func (c *ApplicationClient) UpdateLoginFlow(ctx context.Context, appId string, loginFlowUpdateRequest LoginFlowUpdateModel) error
- func (c *ApplicationClient) UpdateOAuthConfig(ctx context.Context, applicationId string, ...) error
- type ApplicationListResponseModel
- type ApplicationOAuthConfigUpdateModel
- func (c *ApplicationOAuthConfigUpdateModel) WithAccessTokenAttributes(attrs []string) *ApplicationOAuthConfigUpdateModel
- func (c *ApplicationOAuthConfigUpdateModel) WithAllowedOrigins(origins []string) *ApplicationOAuthConfigUpdateModel
- func (c *ApplicationOAuthConfigUpdateModel) WithApplicationAccessTokenExpiry(seconds int64) *ApplicationOAuthConfigUpdateModel
- func (c *ApplicationOAuthConfigUpdateModel) WithCallbackURLs(urls []string) *ApplicationOAuthConfigUpdateModel
- func (c *ApplicationOAuthConfigUpdateModel) WithRefreshTokenExpiry(seconds int64) *ApplicationOAuthConfigUpdateModel
- func (c *ApplicationOAuthConfigUpdateModel) WithUserAccessTokenExpiry(seconds int64) *ApplicationOAuthConfigUpdateModel
- type AuthenticatorModel
- type AuthorizedAPICreateModel
- type AuthorizedAPIResponseModel
- type ClaimModel
- type LoginFlowGenerateResponseModel
- type LoginFlowResultResponseModel
- type LoginFlowStatusResponseModel
- type LoginFlowStepModel
- type LoginFlowTypeModel
- type LoginFlowUpdateModel
- type RequestedClaimModel
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ApplicationBasicInfoResponseModel ¶ added in v0.0.6
type ApplicationBasicInfoResponseModel struct {
Id string `json:"id"`
Name string `json:"name"`
ClientId string `json:"client_id,omitempty"`
ClientSecret string `json:"client_secret,omitempty"`
RedirectURL string `json:"redirect_url,omitempty"`
AuthorizedScopes string `json:"scope,omitempty"`
AppType AppType `json:"application_type"`
}
type ApplicationBasicInfoUpdateModel ¶ added in v0.0.6
type ApplicationBasicInfoUpdateModel struct {
Name *string `json:"name,omitempty"`
Description *string `json:"description,omitempty"`
ImageUrl *string `json:"imageUrl,omitempty"`
AccessUrl *string `json:"accessUrl,omitempty"`
LogoutReturnUrl *string `json:"logoutReturnUrl,omitempty"`
}
ApplicationBasicInfoUpdateModel defines a simplified model for updating basic application information
func NewBasicInfoUpdate ¶ added in v0.0.7
func NewBasicInfoUpdate() *ApplicationBasicInfoUpdateModel
NewBasicInfoUpdate creates a new ApplicationBasicInfoUpdateModel with default values
func (*ApplicationBasicInfoUpdateModel) WithAccessUrl ¶ added in v0.0.7
func (c *ApplicationBasicInfoUpdateModel) WithAccessUrl(accessUrl string) *ApplicationBasicInfoUpdateModel
WithAccessUrl sets application access URL
func (*ApplicationBasicInfoUpdateModel) WithDescription ¶ added in v0.0.7
func (c *ApplicationBasicInfoUpdateModel) WithDescription(description string) *ApplicationBasicInfoUpdateModel
WithDescription sets application description
func (*ApplicationBasicInfoUpdateModel) WithImageUrl ¶ added in v0.0.7
func (c *ApplicationBasicInfoUpdateModel) WithImageUrl(imageUrl string) *ApplicationBasicInfoUpdateModel
WithImageUrl sets application image URL
func (*ApplicationBasicInfoUpdateModel) WithLogoutReturnUrl ¶ added in v0.0.7
func (c *ApplicationBasicInfoUpdateModel) WithLogoutReturnUrl(logoutReturnUrl string) *ApplicationBasicInfoUpdateModel
WithLogoutReturnUrl sets application logout return URL
func (*ApplicationBasicInfoUpdateModel) WithName ¶ added in v0.0.7
func (c *ApplicationBasicInfoUpdateModel) WithName(name string) *ApplicationBasicInfoUpdateModel
WithName sets application name
type ApplicationClaimConfigurationUpdateModel ¶ added in v0.0.14
type ApplicationClaimConfigurationUpdateModel struct {
RequestedClaims *[]RequestedClaimModel `json:"requestedClaims,omitempty"`
}
type ApplicationClient ¶
type ApplicationClient struct {
// contains filtered or unexported fields
}
ApplicationClient is a wrapper around the generated client for the Application Management API
func New ¶
func New(cfg *config.ClientConfig) (*ApplicationClient, error)
New creates a new Application Management API client
func (*ApplicationClient) AuthorizeAPI ¶ added in v0.0.4
func (c *ApplicationClient) AuthorizeAPI(ctx context.Context, appID string, apiAuthorization AuthorizedAPICreateModel) error
AuthorizeAPI authorizes an application to access an API with specified scopes
func (*ApplicationClient) CreateM2MApp ¶ added in v0.0.3
func (c *ApplicationClient) CreateM2MApp(ctx context.Context, name string) (*ApplicationBasicInfoResponseModel, error)
CreateM2MApp creates a new Machine-to-Machine (M2M) Application
func (*ApplicationClient) CreateMobileApp ¶ added in v0.0.3
func (c *ApplicationClient) CreateMobileApp(ctx context.Context, name string, redirectURL string) (*ApplicationBasicInfoResponseModel, error)
CreateMobileApp creates a new Mobile Application with sensible defaults
func (*ApplicationClient) CreateSinglePageApp ¶ added in v0.0.3
func (c *ApplicationClient) CreateSinglePageApp(ctx context.Context, name string, redirectURL string) (*ApplicationBasicInfoResponseModel, error)
CreateSinglePageApp creates a new Single Page Application with sensible defaults
func (*ApplicationClient) CreateWebAppWithSSR ¶ added in v0.0.10
func (c *ApplicationClient) CreateWebAppWithSSR(ctx context.Context, name string, redirectURL string) (*ApplicationBasicInfoResponseModel, error)
CreateWebAppWithSSR creates a new Web Application with Server-Side Rendering support
func (*ApplicationClient) GenerateLoginFlow ¶ added in v0.0.5
func (c *ApplicationClient) GenerateLoginFlow(ctx context.Context, prompt string) (*LoginFlowGenerateResponseModel, error)
GenerateLoginFlow initiates the login flow generation process for an application.
func (*ApplicationClient) GetAuthorizedAPIs ¶ added in v0.0.11
func (c *ApplicationClient) GetAuthorizedAPIs(ctx context.Context, appID string) (*[]AuthorizedAPIResponseModel, error)
GetAuthorizedAPIs retrieves the list of APIs authorized for an application
func (*ApplicationClient) GetByClienId ¶ added in v0.0.3
func (c *ApplicationClient) GetByClienId(ctx context.Context, clientId string) (*ApplicationBasicInfoResponseModel, error)
GetByClienId finds an application by clientId and returns its details todo: improve application details being fetched beyond appId, name, clientId and clientSecret
func (*ApplicationClient) GetByName ¶ added in v0.0.3
func (c *ApplicationClient) GetByName(ctx context.Context, name string) (*ApplicationBasicInfoResponseModel, error)
GetByName finds an application by name and returns its details todo: improve application details being fetched beyond appId, name, clientId and clientSecret
func (*ApplicationClient) GetLoginFlowGenerationResult ¶ added in v0.0.5
func (c *ApplicationClient) GetLoginFlowGenerationResult(ctx context.Context, flowId string) (*LoginFlowResultResponseModel, error)
GetLoginFlowGenerationResult retrieves the result of the login flow generation process.
func (*ApplicationClient) GetLoginFlowGenerationStatus ¶ added in v0.0.5
func (c *ApplicationClient) GetLoginFlowGenerationStatus(ctx context.Context, flowId string) (*LoginFlowStatusResponseModel, error)
GetLoginFlowGenerationStatus retrieves the status of the login flow generation process.
func (*ApplicationClient) List ¶
func (c *ApplicationClient) List(ctx context.Context, limit, offset int) (*ApplicationListResponseModel, error)
List retrieves a list of applications with pagination support
func (*ApplicationClient) UpdateBasicInfo ¶ added in v0.0.6
func (c *ApplicationClient) UpdateBasicInfo(ctx context.Context, appId string, updateModel ApplicationBasicInfoUpdateModel) error
UpdateBasicInfo updates basic information of an existing application
func (*ApplicationClient) UpdateClaimConfig ¶ added in v0.0.14
func (c *ApplicationClient) UpdateClaimConfig(ctx context.Context, appId string, claimConfigUpdateModel ApplicationClaimConfigurationUpdateModel) error
UpdateClaimConfig updates the claim configuration of an existing application
func (*ApplicationClient) UpdateLoginFlow ¶ added in v0.0.8
func (c *ApplicationClient) UpdateLoginFlow(ctx context.Context, appId string, loginFlowUpdateRequest LoginFlowUpdateModel) error
UpdateLoginFlow updates the login flow of an existing application.
func (*ApplicationClient) UpdateOAuthConfig ¶ added in v0.0.7
func (c *ApplicationClient) UpdateOAuthConfig(ctx context.Context, applicationId string, config ApplicationOAuthConfigUpdateModel) error
UpdateOAuthConfig updates allowed OAuth configuration fields for an application
type ApplicationListResponseModel ¶ added in v0.0.6
type ApplicationListResponseModel = internal.ApplicationListResponse
type ApplicationOAuthConfigUpdateModel ¶ added in v0.0.7
type ApplicationOAuthConfigUpdateModel struct {
AccessTokenAttributes *[]string `json:"accessTokenAttributes,omitempty"`
ApplicationAccessTokenExpiryInSeconds *int64 `json:"applicationAccessTokenExpiryInSeconds,omitempty"`
UserAccessTokenExpiryInSeconds *int64 `json:"userAccessTokenExpiryInSeconds,omitempty"`
AllowedOrigins *[]string `json:"allowedOrigins,omitempty"`
CallbackURLs *[]string `json:"callbackURLs,omitempty"`
Logout *internal.OIDCLogoutConfiguration `json:"logout,omitempty"`
RefreshTokenExpiryInSeconds *int64 `json:"refreshTokenExpiryInSeconds,omitempty"`
}
ApplicationOAuthConfigUpdateModel contains only the fields that can be updated in OAuth configuration
func NewOAuthConfigUpdate ¶ added in v0.0.7
func NewOAuthConfigUpdate() *ApplicationOAuthConfigUpdateModel
NewOAuthConfigUpdate creates a new ApplicationOAuthConfigUpdateModel with default values
func (*ApplicationOAuthConfigUpdateModel) WithAccessTokenAttributes ¶ added in v0.0.7
func (c *ApplicationOAuthConfigUpdateModel) WithAccessTokenAttributes(attrs []string) *ApplicationOAuthConfigUpdateModel
WithAccessTokenAttributes sets access token attributes
func (*ApplicationOAuthConfigUpdateModel) WithAllowedOrigins ¶ added in v0.0.7
func (c *ApplicationOAuthConfigUpdateModel) WithAllowedOrigins(origins []string) *ApplicationOAuthConfigUpdateModel
WithAllowedOrigins sets allowed origins for CORS
func (*ApplicationOAuthConfigUpdateModel) WithApplicationAccessTokenExpiry ¶ added in v0.0.7
func (c *ApplicationOAuthConfigUpdateModel) WithApplicationAccessTokenExpiry(seconds int64) *ApplicationOAuthConfigUpdateModel
WithApplicationAccessTokenExpiry sets application access token expiry in seconds
func (*ApplicationOAuthConfigUpdateModel) WithCallbackURLs ¶ added in v0.0.7
func (c *ApplicationOAuthConfigUpdateModel) WithCallbackURLs(urls []string) *ApplicationOAuthConfigUpdateModel
WithCallbackURLs sets callback URLs
func (*ApplicationOAuthConfigUpdateModel) WithRefreshTokenExpiry ¶ added in v0.0.7
func (c *ApplicationOAuthConfigUpdateModel) WithRefreshTokenExpiry(seconds int64) *ApplicationOAuthConfigUpdateModel
WithRefreshTokenExpiry sets refresh token expiry in seconds
func (*ApplicationOAuthConfigUpdateModel) WithUserAccessTokenExpiry ¶ added in v0.0.7
func (c *ApplicationOAuthConfigUpdateModel) WithUserAccessTokenExpiry(seconds int64) *ApplicationOAuthConfigUpdateModel
WithUserAccessTokenExpiry sets user access token expiry in seconds
type AuthenticatorModel ¶ added in v0.0.8
type AuthenticatorModel = internal.Authenticator
type AuthorizedAPICreateModel ¶ added in v0.0.6
type AuthorizedAPICreateModel = internal.AddAuthorizedAPIJSONRequestBody
type AuthorizedAPIResponseModel ¶ added in v0.0.11
type AuthorizedAPIResponseModel = internal.AuthorizedAPIResponse
type ClaimModel ¶ added in v0.0.14
type LoginFlowGenerateResponseModel ¶ added in v0.0.6
type LoginFlowGenerateResponseModel = internal.LoginFlowGenerateResponse
type LoginFlowResultResponseModel ¶ added in v0.0.6
type LoginFlowResultResponseModel struct {
Data *LoginFlowUpdateModel `json:"data,omitempty"`
Status *internal.StatusEnum `json:"status,omitempty"`
}
type LoginFlowStatusResponseModel ¶ added in v0.0.6
type LoginFlowStatusResponseModel = internal.LoginFlowStatusResponse
type LoginFlowStepModel ¶ added in v0.0.8
type LoginFlowStepModel = internal.AuthenticationStepModel
type LoginFlowTypeModel ¶ added in v0.0.8
type LoginFlowTypeModel = internal.AuthenticationSequenceType
type LoginFlowUpdateModel ¶ added in v0.0.8
type LoginFlowUpdateModel = internal.AuthenticationSequence
type RequestedClaimModel ¶ added in v0.0.14
type RequestedClaimModel struct {
Claim ClaimModel `json:"claim"`
Mandatory *bool `json:"mandatory"`
}