accountauthentication

package
v0.57.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 25, 2024 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AuthenticationMethodStateTypeChoices added in v0.3.0

func AuthenticationMethodStateTypeChoices() []string

func AuthenticationMethodTypeChoices

func AuthenticationMethodTypeChoices() []string

func SamlCertTypeChoices added in v0.3.0

func SamlCertTypeChoices() []string

func SamlDigestAlgorithmTypeChoices

func SamlDigestAlgorithmTypeChoices() []string

func SamlSignatureAlgorithmTypeChoices

func SamlSignatureAlgorithmTypeChoices() []string

func SamlVariantTypeChoices

func SamlVariantTypeChoices() []string

Types

type AccountAuthenticationHandler

type AccountAuthenticationHandler struct {
	// contains filtered or unexported fields
}

func NewHandler

func NewHandler(doer doer) AccountAuthenticationHandler

func (*AccountAuthenticationHandler) AccountAuthenticationMethodCreate

func (*AccountAuthenticationHandler) AccountAuthenticationMethodDelete

func (h *AccountAuthenticationHandler) AccountAuthenticationMethodDelete(ctx context.Context, accountId string, accountAuthenticationMethodId string) error

func (*AccountAuthenticationHandler) AccountAuthenticationMethodGet

func (h *AccountAuthenticationHandler) AccountAuthenticationMethodGet(ctx context.Context, accountId string, accountAuthenticationMethodId string) (*AccountAuthenticationMethodGetOut, error)

func (*AccountAuthenticationHandler) AccountAuthenticationMethodUpdate

func (h *AccountAuthenticationHandler) AccountAuthenticationMethodUpdate(ctx context.Context, accountId string, accountAuthenticationMethodId string, in *AccountAuthenticationMethodUpdateIn) (*AccountAuthenticationMethodUpdateOut, error)

func (*AccountAuthenticationHandler) AccountAuthenticationMethodsList

func (h *AccountAuthenticationHandler) AccountAuthenticationMethodsList(ctx context.Context, accountId string) ([]AuthenticationMethodOut, error)

type AccountAuthenticationMethodCreateIn

type AccountAuthenticationMethodCreateIn struct {
	AuthTokenExtendWhenUsed          *bool                      `json:"auth_token_extend_when_used,omitempty"`          // Extend authentication token validity when used
	AuthTokenMaxAgeSeconds           *int                       `json:"auth_token_max_age_seconds,omitempty"`           // Auth Token Max Age Seconds
	AuthenticationMethodName         string                     `json:"authentication_method_name"`                     // Authentication Method Name
	AuthenticationMethodType         AuthenticationMethodType   `json:"authentication_method_type"`                     // Authentication method type
	AutoJoinTeamId                   *string                    `json:"auto_join_team_id,omitempty"`                    // Automatically add users to a team, when user signs up using this authentication method
	AutoJoinUserGroupId              *string                    `json:"auto_join_user_group_id,omitempty"`              // Automatically add users to a group, when user signs up using this authentication method
	LinkedDomains                    *[]LinkedDomainIn          `json:"linked_domains,omitempty"`                       // Linked Domains
	SamlAssertionSignedEnabled       *bool                      `json:"saml_assertion_signed_enabled,omitempty"`        // Set to 'true' to enable WantAssertionsSigned
	SamlAuthnRequestsSignedEnabled   *bool                      `json:"saml_authn_requests_signed_enabled,omitempty"`   // Set to 'true' to enable AuthnRequestsSigned
	SamlCertificate                  *string                    `json:"saml_certificate,omitempty"`                     // Identity provider's certificate
	SamlDigestAlgorithm              SamlDigestAlgorithmType    `json:"saml_digest_algorithm,omitempty"`                // Digest algorithm. This is an advanced option that typically does not need to be set.
	SamlEntityId                     *string                    `json:"saml_entity_id,omitempty"`                       // Saml Entity ID
	SamlFieldMapping                 *SamlFieldMappingIn        `json:"saml_field_mapping,omitempty"`                   // SAMLFieldMapping
	SamlIdpLoginAllowed              *bool                      `json:"saml_idp_login_allowed,omitempty"`               // Set to 'true' to enable IdP initiated login
	SamlIdpUrl                       *string                    `json:"saml_idp_url,omitempty"`                         // Saml Idp Url
	SamlJoinGroups                   *bool                      `json:"saml_join_groups,omitempty"`                     // SAML join groups enabled
	SamlRequestedAuthnContextEnabled *bool                      `json:"saml_requested_authn_context_enabled,omitempty"` // Set to 'false' to disable RequestedAuthnContext
	SamlSignatureAlgorithm           SamlSignatureAlgorithmType `json:"saml_signature_algorithm,omitempty"`             // SAMLSignatureAlgorithm
	SamlVariant                      SamlVariantType            `json:"saml_variant,omitempty"`                         // SAMLVariant
	ScimEnabled                      *bool                      `json:"scim_enabled,omitempty"`                         // SCIM enabled
}

AccountAuthenticationMethodCreateIn AccountAuthenticationMethodCreateRequestBody

type AccountAuthenticationMethodCreateOut

type AccountAuthenticationMethodCreateOut struct {
	AccountId                        string                        `json:"account_id"`                                     // Account ID
	AuthTokenExtendWhenUsed          *bool                         `json:"auth_token_extend_when_used,omitempty"`          // Extend authentication token validity when used
	AuthTokenMaxAgeSeconds           *int                          `json:"auth_token_max_age_seconds,omitempty"`           // Auth Token Max Age Seconds
	AuthenticationMethodEnabled      bool                          `json:"authentication_method_enabled"`                  // If true, authentication method can be used to access account/projects in account. If false, authentication method can still be used to sign in
	AuthenticationMethodId           string                        `json:"authentication_method_id"`                       // Authentication Method ID
	AuthenticationMethodName         *string                       `json:"authentication_method_name,omitempty"`           // Authentication Method Name
	AuthenticationMethodType         AuthenticationMethodType      `json:"authentication_method_type"`                     // Authentication method type
	AutoJoinTeamId                   string                        `json:"auto_join_team_id"`                              // Automatically add users to a team, when user signs up using this authentication method
	AutoJoinUserGroupId              string                        `json:"auto_join_user_group_id"`                        // Automatically add users to a group, when user signs up using this authentication method
	CreateTime                       time.Time                     `json:"create_time"`                                    // Create Time
	DeleteTime                       time.Time                     `json:"delete_time"`                                    // Delete Time
	OrganizationId                   *string                       `json:"organization_id,omitempty"`                      // Organization ID
	SamlAcsUrl                       *string                       `json:"saml_acs_url,omitempty"`                         // Saml Acs Url
	SamlAssertionSignedEnabled       *bool                         `json:"saml_assertion_signed_enabled,omitempty"`        // Set to 'true' to enable WantAssertionsSigned
	SamlAuthnRequestsSignedEnabled   *bool                         `json:"saml_authn_requests_signed_enabled,omitempty"`   // Set to 'true' to enable AuthnRequestsSigned
	SamlCert                         SamlCertType                  `json:"saml_cert,omitempty"`                            // SAMLVariant
	SamlCertificate                  *string                       `json:"saml_certificate,omitempty"`                     // Identity provider's certificate
	SamlCertificateIssuer            *string                       `json:"saml_certificate_issuer,omitempty"`              // Saml Certificate Issuer
	SamlCertificateNotValidAfter     *string                       `json:"saml_certificate_not_valid_after,omitempty"`     // Saml Certificate Not Valid After
	SamlCertificateNotValidBefore    *string                       `json:"saml_certificate_not_valid_before,omitempty"`    // Saml Certificate Not Valid Before
	SamlCertificateSubject           *string                       `json:"saml_certificate_subject,omitempty"`             // Saml Certificate Subject
	SamlDigestAlgorithm              SamlDigestAlgorithmType       `json:"saml_digest_algorithm,omitempty"`                // Digest algorithm. This is an advanced option that typically does not need to be set.
	SamlEntityId                     *string                       `json:"saml_entity_id,omitempty"`                       // Saml Entity ID
	SamlFieldMapping                 *SamlFieldMappingOut          `json:"saml_field_mapping,omitempty"`                   // SAMLFieldMapping
	SamlIdpLoginAllowed              *bool                         `json:"saml_idp_login_allowed,omitempty"`               // Set to 'true' to enable IdP initiated login
	SamlIdpUrl                       *string                       `json:"saml_idp_url,omitempty"`                         // Saml Idp Url
	SamlJoinGroups                   *bool                         `json:"saml_join_groups,omitempty"`                     // SAML join groups enabled
	SamlMetadataUrl                  *string                       `json:"saml_metadata_url,omitempty"`                    // Saml Metadata Url
	SamlRequestedAuthnContextEnabled *bool                         `json:"saml_requested_authn_context_enabled,omitempty"` // Set to 'false' to disable RequestedAuthnContext
	SamlSignatureAlgorithm           SamlSignatureAlgorithmType    `json:"saml_signature_algorithm,omitempty"`             // SAMLSignatureAlgorithm
	SamlSpCertificate                *string                       `json:"saml_sp_certificate,omitempty"`                  // Saml Sp Certificate
	SamlVariant                      SamlVariantType               `json:"saml_variant,omitempty"`                         // SAMLVariant
	ScimEnabled                      *bool                         `json:"scim_enabled,omitempty"`                         // SCIM API enabled
	ScimUrl                          *string                       `json:"scim_url,omitempty"`                             // Scim Url
	State                            AuthenticationMethodStateType `json:"state"`                                          // AuthenticationMethodState
	UpdateTime                       time.Time                     `json:"update_time"`                                    // Update Time
}

AccountAuthenticationMethodCreateOut AuthenticationMethod

type AccountAuthenticationMethodGetOut

type AccountAuthenticationMethodGetOut struct {
	AccountId                        string                        `json:"account_id"`                                     // Account ID
	AuthTokenExtendWhenUsed          *bool                         `json:"auth_token_extend_when_used,omitempty"`          // Extend authentication token validity when used
	AuthTokenMaxAgeSeconds           *int                          `json:"auth_token_max_age_seconds,omitempty"`           // Auth Token Max Age Seconds
	AuthenticationMethodEnabled      bool                          `json:"authentication_method_enabled"`                  // If true, authentication method can be used to access account/projects in account. If false, authentication method can still be used to sign in
	AuthenticationMethodId           string                        `json:"authentication_method_id"`                       // Authentication Method ID
	AuthenticationMethodName         *string                       `json:"authentication_method_name,omitempty"`           // Authentication Method Name
	AuthenticationMethodType         AuthenticationMethodType      `json:"authentication_method_type"`                     // Authentication method type
	AutoJoinTeamId                   string                        `json:"auto_join_team_id"`                              // Automatically add users to a team, when user signs up using this authentication method
	AutoJoinUserGroupId              string                        `json:"auto_join_user_group_id"`                        // Automatically add users to a group, when user signs up using this authentication method
	CreateTime                       time.Time                     `json:"create_time"`                                    // Create Time
	DeleteTime                       time.Time                     `json:"delete_time"`                                    // Delete Time
	OrganizationId                   *string                       `json:"organization_id,omitempty"`                      // Organization ID
	SamlAcsUrl                       *string                       `json:"saml_acs_url,omitempty"`                         // Saml Acs Url
	SamlAssertionSignedEnabled       *bool                         `json:"saml_assertion_signed_enabled,omitempty"`        // Set to 'true' to enable WantAssertionsSigned
	SamlAuthnRequestsSignedEnabled   *bool                         `json:"saml_authn_requests_signed_enabled,omitempty"`   // Set to 'true' to enable AuthnRequestsSigned
	SamlCert                         SamlCertType                  `json:"saml_cert,omitempty"`                            // SAMLVariant
	SamlCertificate                  *string                       `json:"saml_certificate,omitempty"`                     // Identity provider's certificate
	SamlCertificateIssuer            *string                       `json:"saml_certificate_issuer,omitempty"`              // Saml Certificate Issuer
	SamlCertificateNotValidAfter     *string                       `json:"saml_certificate_not_valid_after,omitempty"`     // Saml Certificate Not Valid After
	SamlCertificateNotValidBefore    *string                       `json:"saml_certificate_not_valid_before,omitempty"`    // Saml Certificate Not Valid Before
	SamlCertificateSubject           *string                       `json:"saml_certificate_subject,omitempty"`             // Saml Certificate Subject
	SamlDigestAlgorithm              SamlDigestAlgorithmType       `json:"saml_digest_algorithm,omitempty"`                // Digest algorithm. This is an advanced option that typically does not need to be set.
	SamlEntityId                     *string                       `json:"saml_entity_id,omitempty"`                       // Saml Entity ID
	SamlFieldMapping                 *SamlFieldMappingOut          `json:"saml_field_mapping,omitempty"`                   // SAMLFieldMapping
	SamlIdpLoginAllowed              *bool                         `json:"saml_idp_login_allowed,omitempty"`               // Set to 'true' to enable IdP initiated login
	SamlIdpUrl                       *string                       `json:"saml_idp_url,omitempty"`                         // Saml Idp Url
	SamlJoinGroups                   *bool                         `json:"saml_join_groups,omitempty"`                     // SAML join groups enabled
	SamlMetadataUrl                  *string                       `json:"saml_metadata_url,omitempty"`                    // Saml Metadata Url
	SamlRequestedAuthnContextEnabled *bool                         `json:"saml_requested_authn_context_enabled,omitempty"` // Set to 'false' to disable RequestedAuthnContext
	SamlSignatureAlgorithm           SamlSignatureAlgorithmType    `json:"saml_signature_algorithm,omitempty"`             // SAMLSignatureAlgorithm
	SamlSpCertificate                *string                       `json:"saml_sp_certificate,omitempty"`                  // Saml Sp Certificate
	SamlVariant                      SamlVariantType               `json:"saml_variant,omitempty"`                         // SAMLVariant
	ScimEnabled                      *bool                         `json:"scim_enabled,omitempty"`                         // SCIM API enabled
	ScimUrl                          *string                       `json:"scim_url,omitempty"`                             // Scim Url
	State                            AuthenticationMethodStateType `json:"state"`                                          // AuthenticationMethodState
	UpdateTime                       time.Time                     `json:"update_time"`                                    // Update Time
}

AccountAuthenticationMethodGetOut AuthenticationMethod

type AccountAuthenticationMethodUpdateIn

type AccountAuthenticationMethodUpdateIn struct {
	AuthTokenExtendWhenUsed          *bool                      `json:"auth_token_extend_when_used,omitempty"`          // Extend authentication token validity when used
	AuthTokenMaxAgeSeconds           *int                       `json:"auth_token_max_age_seconds,omitempty"`           // Auth Token Max Age Seconds
	AuthenticationMethodEnabled      *bool                      `json:"authentication_method_enabled,omitempty"`        // If true, authentication method can be used to access account/projects in account. If false, authentication method can still be used to sign in
	AuthenticationMethodName         *string                    `json:"authentication_method_name,omitempty"`           // Authentication Method Name
	AutoJoinTeamId                   *string                    `json:"auto_join_team_id,omitempty"`                    // Automatically add users to a team, when user signs up using this authentication method
	AutoJoinUserGroupId              *string                    `json:"auto_join_user_group_id,omitempty"`              // Automatically add users to a group, when user signs up using this authentication method
	SamlAssertionSignedEnabled       *bool                      `json:"saml_assertion_signed_enabled,omitempty"`        // Set to 'true' to enable WantAssertionsSigned
	SamlAuthnRequestsSignedEnabled   *bool                      `json:"saml_authn_requests_signed_enabled,omitempty"`   // Set to 'true' to enable AuthnRequestsSigned
	SamlCertificate                  *string                    `json:"saml_certificate,omitempty"`                     // Identity provider's certificate
	SamlDigestAlgorithm              SamlDigestAlgorithmType    `json:"saml_digest_algorithm,omitempty"`                // Digest algorithm. This is an advanced option that typically does not need to be set.
	SamlEntityId                     *string                    `json:"saml_entity_id,omitempty"`                       // Saml Entity ID
	SamlFieldMapping                 *SamlFieldMappingIn        `json:"saml_field_mapping,omitempty"`                   // SAMLFieldMapping
	SamlIdpLoginAllowed              *bool                      `json:"saml_idp_login_allowed,omitempty"`               // Set to 'true' to enable IdP initiated login
	SamlIdpUrl                       *string                    `json:"saml_idp_url,omitempty"`                         // Saml Idp Url
	SamlJoinGroups                   *bool                      `json:"saml_join_groups,omitempty"`                     // SAML join groups enabled
	SamlRequestedAuthnContextEnabled *bool                      `json:"saml_requested_authn_context_enabled,omitempty"` // Set to 'false' to disable RequestedAuthnContext
	SamlSignatureAlgorithm           SamlSignatureAlgorithmType `json:"saml_signature_algorithm,omitempty"`             // SAMLSignatureAlgorithm
	SamlVariant                      SamlVariantType            `json:"saml_variant,omitempty"`                         // SAMLVariant
	ScimEnabled                      *bool                      `json:"scim_enabled,omitempty"`                         // SCIM enabled
}

AccountAuthenticationMethodUpdateIn AccountAuthenticationMethodUpdateRequestBody

type AccountAuthenticationMethodUpdateOut

type AccountAuthenticationMethodUpdateOut struct {
	AccountId                        string                        `json:"account_id"`                                     // Account ID
	AuthTokenExtendWhenUsed          *bool                         `json:"auth_token_extend_when_used,omitempty"`          // Extend authentication token validity when used
	AuthTokenMaxAgeSeconds           *int                          `json:"auth_token_max_age_seconds,omitempty"`           // Auth Token Max Age Seconds
	AuthenticationMethodEnabled      bool                          `json:"authentication_method_enabled"`                  // If true, authentication method can be used to access account/projects in account. If false, authentication method can still be used to sign in
	AuthenticationMethodId           string                        `json:"authentication_method_id"`                       // Authentication Method ID
	AuthenticationMethodName         *string                       `json:"authentication_method_name,omitempty"`           // Authentication Method Name
	AuthenticationMethodType         AuthenticationMethodType      `json:"authentication_method_type"`                     // Authentication method type
	AutoJoinTeamId                   string                        `json:"auto_join_team_id"`                              // Automatically add users to a team, when user signs up using this authentication method
	AutoJoinUserGroupId              string                        `json:"auto_join_user_group_id"`                        // Automatically add users to a group, when user signs up using this authentication method
	CreateTime                       time.Time                     `json:"create_time"`                                    // Create Time
	DeleteTime                       time.Time                     `json:"delete_time"`                                    // Delete Time
	OrganizationId                   *string                       `json:"organization_id,omitempty"`                      // Organization ID
	SamlAcsUrl                       *string                       `json:"saml_acs_url,omitempty"`                         // Saml Acs Url
	SamlAssertionSignedEnabled       *bool                         `json:"saml_assertion_signed_enabled,omitempty"`        // Set to 'true' to enable WantAssertionsSigned
	SamlAuthnRequestsSignedEnabled   *bool                         `json:"saml_authn_requests_signed_enabled,omitempty"`   // Set to 'true' to enable AuthnRequestsSigned
	SamlCert                         SamlCertType                  `json:"saml_cert,omitempty"`                            // SAMLVariant
	SamlCertificate                  *string                       `json:"saml_certificate,omitempty"`                     // Identity provider's certificate
	SamlCertificateIssuer            *string                       `json:"saml_certificate_issuer,omitempty"`              // Saml Certificate Issuer
	SamlCertificateNotValidAfter     *string                       `json:"saml_certificate_not_valid_after,omitempty"`     // Saml Certificate Not Valid After
	SamlCertificateNotValidBefore    *string                       `json:"saml_certificate_not_valid_before,omitempty"`    // Saml Certificate Not Valid Before
	SamlCertificateSubject           *string                       `json:"saml_certificate_subject,omitempty"`             // Saml Certificate Subject
	SamlDigestAlgorithm              SamlDigestAlgorithmType       `json:"saml_digest_algorithm,omitempty"`                // Digest algorithm. This is an advanced option that typically does not need to be set.
	SamlEntityId                     *string                       `json:"saml_entity_id,omitempty"`                       // Saml Entity ID
	SamlFieldMapping                 *SamlFieldMappingOut          `json:"saml_field_mapping,omitempty"`                   // SAMLFieldMapping
	SamlIdpLoginAllowed              *bool                         `json:"saml_idp_login_allowed,omitempty"`               // Set to 'true' to enable IdP initiated login
	SamlIdpUrl                       *string                       `json:"saml_idp_url,omitempty"`                         // Saml Idp Url
	SamlJoinGroups                   *bool                         `json:"saml_join_groups,omitempty"`                     // SAML join groups enabled
	SamlMetadataUrl                  *string                       `json:"saml_metadata_url,omitempty"`                    // Saml Metadata Url
	SamlRequestedAuthnContextEnabled *bool                         `json:"saml_requested_authn_context_enabled,omitempty"` // Set to 'false' to disable RequestedAuthnContext
	SamlSignatureAlgorithm           SamlSignatureAlgorithmType    `json:"saml_signature_algorithm,omitempty"`             // SAMLSignatureAlgorithm
	SamlSpCertificate                *string                       `json:"saml_sp_certificate,omitempty"`                  // Saml Sp Certificate
	SamlVariant                      SamlVariantType               `json:"saml_variant,omitempty"`                         // SAMLVariant
	ScimEnabled                      *bool                         `json:"scim_enabled,omitempty"`                         // SCIM API enabled
	ScimUrl                          *string                       `json:"scim_url,omitempty"`                             // Scim Url
	State                            AuthenticationMethodStateType `json:"state"`                                          // AuthenticationMethodState
	UpdateTime                       time.Time                     `json:"update_time"`                                    // Update Time
}

AccountAuthenticationMethodUpdateOut AuthenticationMethod

type AuthenticationMethodOut

type AuthenticationMethodOut struct {
	AccountId                        string                        `json:"account_id"`                                     // Account ID
	AuthTokenExtendWhenUsed          *bool                         `json:"auth_token_extend_when_used,omitempty"`          // Extend authentication token validity when used
	AuthTokenMaxAgeSeconds           *int                          `json:"auth_token_max_age_seconds,omitempty"`           // Auth Token Max Age Seconds
	AuthenticationMethodEnabled      bool                          `json:"authentication_method_enabled"`                  // If true, authentication method can be used to access account/projects in account. If false, authentication method can still be used to sign in
	AuthenticationMethodId           string                        `json:"authentication_method_id"`                       // Authentication Method ID
	AuthenticationMethodName         *string                       `json:"authentication_method_name,omitempty"`           // Authentication Method Name
	AuthenticationMethodType         AuthenticationMethodType      `json:"authentication_method_type"`                     // Authentication method type
	AutoJoinTeamId                   string                        `json:"auto_join_team_id"`                              // Automatically add users to a team, when user signs up using this authentication method
	AutoJoinUserGroupId              string                        `json:"auto_join_user_group_id"`                        // Automatically add users to a group, when user signs up using this authentication method
	CreateTime                       time.Time                     `json:"create_time"`                                    // Create Time
	DeleteTime                       time.Time                     `json:"delete_time"`                                    // Delete Time
	OrganizationId                   *string                       `json:"organization_id,omitempty"`                      // Organization ID
	SamlAcsUrl                       *string                       `json:"saml_acs_url,omitempty"`                         // Saml Acs Url
	SamlAssertionSignedEnabled       *bool                         `json:"saml_assertion_signed_enabled,omitempty"`        // Set to 'true' to enable WantAssertionsSigned
	SamlAuthnRequestsSignedEnabled   *bool                         `json:"saml_authn_requests_signed_enabled,omitempty"`   // Set to 'true' to enable AuthnRequestsSigned
	SamlCert                         SamlCertType                  `json:"saml_cert,omitempty"`                            // SAMLVariant
	SamlCertificate                  *string                       `json:"saml_certificate,omitempty"`                     // Identity provider's certificate
	SamlCertificateIssuer            *string                       `json:"saml_certificate_issuer,omitempty"`              // Saml Certificate Issuer
	SamlCertificateNotValidAfter     *string                       `json:"saml_certificate_not_valid_after,omitempty"`     // Saml Certificate Not Valid After
	SamlCertificateNotValidBefore    *string                       `json:"saml_certificate_not_valid_before,omitempty"`    // Saml Certificate Not Valid Before
	SamlCertificateSubject           *string                       `json:"saml_certificate_subject,omitempty"`             // Saml Certificate Subject
	SamlDigestAlgorithm              SamlDigestAlgorithmType       `json:"saml_digest_algorithm,omitempty"`                // Digest algorithm. This is an advanced option that typically does not need to be set.
	SamlEntityId                     *string                       `json:"saml_entity_id,omitempty"`                       // Saml Entity ID
	SamlFieldMapping                 *SamlFieldMappingOut          `json:"saml_field_mapping,omitempty"`                   // SAMLFieldMapping
	SamlIdpLoginAllowed              *bool                         `json:"saml_idp_login_allowed,omitempty"`               // Set to 'true' to enable IdP initiated login
	SamlIdpUrl                       *string                       `json:"saml_idp_url,omitempty"`                         // Saml Idp Url
	SamlJoinGroups                   *bool                         `json:"saml_join_groups,omitempty"`                     // SAML join groups enabled
	SamlMetadataUrl                  *string                       `json:"saml_metadata_url,omitempty"`                    // Saml Metadata Url
	SamlRequestedAuthnContextEnabled *bool                         `json:"saml_requested_authn_context_enabled,omitempty"` // Set to 'false' to disable RequestedAuthnContext
	SamlSignatureAlgorithm           SamlSignatureAlgorithmType    `json:"saml_signature_algorithm,omitempty"`             // SAMLSignatureAlgorithm
	SamlSpCertificate                *string                       `json:"saml_sp_certificate,omitempty"`                  // Saml Sp Certificate
	SamlVariant                      SamlVariantType               `json:"saml_variant,omitempty"`                         // SAMLVariant
	ScimEnabled                      *bool                         `json:"scim_enabled,omitempty"`                         // SCIM API enabled
	ScimUrl                          *string                       `json:"scim_url,omitempty"`                             // Scim Url
	State                            AuthenticationMethodStateType `json:"state"`                                          // AuthenticationMethodState
	UpdateTime                       time.Time                     `json:"update_time"`                                    // Update Time
}

type AuthenticationMethodStateType added in v0.3.0

type AuthenticationMethodStateType string
const (
	AuthenticationMethodStateTypeActive               AuthenticationMethodStateType = "active"
	AuthenticationMethodStateTypeDeleted              AuthenticationMethodStateType = "deleted"
	AuthenticationMethodStateTypePendingConfiguration AuthenticationMethodStateType = "pending_configuration"
)

type AuthenticationMethodType

type AuthenticationMethodType string
const (
	AuthenticationMethodTypeInternal AuthenticationMethodType = "internal"
	AuthenticationMethodTypeSaml     AuthenticationMethodType = "saml"
)

type Handler

type Handler interface {
	// AccountAuthenticationMethodCreate create a new authentication method
	// POST /v1/account/{account_id}/authentication
	// https://api.aiven.io/doc/#tag/Account/operation/AccountAuthenticationMethodCreate
	AccountAuthenticationMethodCreate(ctx context.Context, accountId string, in *AccountAuthenticationMethodCreateIn) (*AccountAuthenticationMethodCreateOut, error)

	// AccountAuthenticationMethodDelete delete authentication method
	// DELETE /v1/account/{account_id}/authentication/{account_authentication_method_id}
	// https://api.aiven.io/doc/#tag/Account/operation/AccountAuthenticationMethodDelete
	AccountAuthenticationMethodDelete(ctx context.Context, accountId string, accountAuthenticationMethodId string) error

	// AccountAuthenticationMethodGet get details of a single authentication method
	// GET /v1/account/{account_id}/authentication/{account_authentication_method_id}
	// https://api.aiven.io/doc/#tag/Account/operation/AccountAuthenticationMethodGet
	AccountAuthenticationMethodGet(ctx context.Context, accountId string, accountAuthenticationMethodId string) (*AccountAuthenticationMethodGetOut, error)

	// AccountAuthenticationMethodUpdate update authentication method
	// PUT /v1/account/{account_id}/authentication/{account_authentication_method_id}
	// https://api.aiven.io/doc/#tag/Account/operation/AccountAuthenticationMethodUpdate
	AccountAuthenticationMethodUpdate(ctx context.Context, accountId string, accountAuthenticationMethodId string, in *AccountAuthenticationMethodUpdateIn) (*AccountAuthenticationMethodUpdateOut, error)

	// AccountAuthenticationMethodsList list authentication methods
	// GET /v1/account/{account_id}/authentication
	// https://api.aiven.io/doc/#tag/Account/operation/AccountAuthenticationMethodsList
	AccountAuthenticationMethodsList(ctx context.Context, accountId string) ([]AuthenticationMethodOut, error)
}

type LinkedDomainIn

type LinkedDomainIn struct {
	DomainId string `json:"domain_id"` // Domain ID
}

type SamlCertType added in v0.3.0

type SamlCertType string
const (
	SamlCertTypeAdfs SamlCertType = "adfs"
)

type SamlDigestAlgorithmType

type SamlDigestAlgorithmType string
const (
	SamlDigestAlgorithmTypeSha1   SamlDigestAlgorithmType = "sha1"
	SamlDigestAlgorithmTypeSha256 SamlDigestAlgorithmType = "sha256"
	SamlDigestAlgorithmTypeSha384 SamlDigestAlgorithmType = "sha384"
	SamlDigestAlgorithmTypeSha512 SamlDigestAlgorithmType = "sha512"
)

type SamlFieldMappingIn

type SamlFieldMappingIn struct {
	Email     *string `json:"email,omitempty"`      // Field name for user email
	FirstName *string `json:"first_name,omitempty"` // Field name for user's first name
	Groups    *string `json:"groups,omitempty"`     // Field name for user's groups memberships. Contents of this field are used to handle group memberships when SCIM is not available and SAML is used to manage group memberships.
	Identity  *string `json:"identity,omitempty"`   // Field name for user's identity. This field must always exist in responses, and must be immutable and unique. Contents of this field are used to identify the user. Using user ID (such as unix user ID) is highly recommended, as email address may change, requiring relinking user to Aiven user.
	LastName  *string `json:"last_name,omitempty"`  // Field name for user's lastname
	RealName  *string `json:"real_name,omitempty"`  // Field name for user's full name. If specified, first_name and last_name mappings are ignored
}

SamlFieldMappingIn SAMLFieldMapping

type SamlFieldMappingOut

type SamlFieldMappingOut struct {
	Email     *string `json:"email,omitempty"`      // Field name for user email
	FirstName *string `json:"first_name,omitempty"` // Field name for user's first name
	Groups    *string `json:"groups,omitempty"`     // Field name for user's groups memberships. Contents of this field are used to handle group memberships when SCIM is not available and SAML is used to manage group memberships.
	Identity  *string `json:"identity,omitempty"`   // Field name for user's identity. This field must always exist in responses, and must be immutable and unique. Contents of this field are used to identify the user. Using user ID (such as unix user ID) is highly recommended, as email address may change, requiring relinking user to Aiven user.
	LastName  *string `json:"last_name,omitempty"`  // Field name for user's lastname
	RealName  *string `json:"real_name,omitempty"`  // Field name for user's full name. If specified, first_name and last_name mappings are ignored
}

SamlFieldMappingOut SAMLFieldMapping

type SamlSignatureAlgorithmType

type SamlSignatureAlgorithmType string
const (
	SamlSignatureAlgorithmTypeRsaSha1   SamlSignatureAlgorithmType = "rsa-sha1"
	SamlSignatureAlgorithmTypeDsaSha1   SamlSignatureAlgorithmType = "dsa-sha1"
	SamlSignatureAlgorithmTypeRsaSha256 SamlSignatureAlgorithmType = "rsa-sha256"
	SamlSignatureAlgorithmTypeRsaSha384 SamlSignatureAlgorithmType = "rsa-sha384"
	SamlSignatureAlgorithmTypeRsaSha512 SamlSignatureAlgorithmType = "rsa-sha512"
)

type SamlVariantType

type SamlVariantType string
const (
	SamlVariantTypeAdfs SamlVariantType = "adfs"
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL