organization

Documentation

Index

• type BZCertValidationInfo
• type EnableGlobalRegistrationKeyRequest
• type Group
• type IdentityProvider
• type Organization
• type OrganizationService
  • func (s *OrganizationService) DeleteIdpGroupCredentials(ctx context.Context) (*http.Response, error)
  • func (s *OrganizationService) DisableGlobalRegistrationKey(ctx context.Context) (*RegistrationKeySettings, *http.Response, error)
  • func (s *OrganizationService) EnableGlobalRegistrationKey(ctx context.Context, request *EnableGlobalRegistrationKeyRequest) (*RegistrationKeySettings, *http.Response, error)
  • func (s *OrganizationService) FetchGroups(ctx context.Context) ([]Group, *http.Response, error)
  • func (s *OrganizationService) FetchUserGroups(ctx context.Context, userID string) ([]Group, *http.Response, error)
  • func (s *OrganizationService) GetBZCertValidationInfo(ctx context.Context) (*BZCertValidationInfo, *http.Response, error)
  • func (s *OrganizationService) GetIdentityProvider(ctx context.Context) (*IdentityProvider, *http.Response, error)
  • func (s *OrganizationService) GetOrganization(ctx context.Context) (*Organization, *http.Response, error)
  • func (s *OrganizationService) GetRegistrationKeySettings(ctx context.Context) (*RegistrationKeySettings, *http.Response, error)
  • func (s *OrganizationService) GetSlackIntegration(ctx context.Context) (*SlackIntegration, *http.Response, error)
  • func (s *OrganizationService) InvalidateKeycloakProviderCache(ctx context.Context) (*http.Response, error)
  • func (s *OrganizationService) ListGroups(ctx context.Context) ([]Group, *http.Response, error)
• type RegistrationKeySettings
• type SlackIntegration

Types

type BZCertValidationInfo

type BZCertValidationInfo struct {
	OrgIdpProvider string `json:"orgIdpProvider"`
	OrgIdpIssuerId string `json:"orgIdpIssuerId"`
}

BZCertValidationInfo contains information needed to validate BZCerts issued for one's BastionZero organization.

type EnableGlobalRegistrationKeyRequest

type EnableGlobalRegistrationKeyRequest struct {
	// DefaultRegistrationKeyId is the identifier for the registration key that
	// should be set as the default global registration key.
	DefaultRegistrationKeyId string `json:"defaultRegistrationKeyId"`
}

EnableGlobalRegistrationKeyRequest is used to enable global registration key enforcement

type Group

type Group struct {
	ID   string `json:"idPGroupId"`
	Name string `json:"name"`
}

Group is an Identity provider (IdP) group synced to BastionZero. A group contains users from an organization.

type IdentityProvider

type IdentityProvider struct {
	IdentityProviderType string `json:"identityProviderType"`
	IdentityProviderId   string `json:"identityProviderId"`
}

IdentityProvider represents the identity provider (IdP) for one's BastionZero organization.

type Organization

type Organization struct {
	ID                       string          `json:"id"`
	Name                     string          `json:"name"`
	IsSingleUserOrganization bool            `json:"isSingleUserOrganization"`
	TimeCreated              types.Timestamp `json:"timeCreated"`
}

Organization represents a BastionZero organization.

type OrganizationService

type OrganizationService client.Service

OrganizationService handles communication with the organization endpoints of the BastionZero API.

BastionZero API docs: https://cloud.bastionzero.com/api/#tag--Organization

func (*OrganizationService) DeleteIdpGroupCredentials

func (s *OrganizationService) DeleteIdpGroupCredentials(ctx context.Context) (*http.Response, error)

DeleteIdpGroupCredentials deletes the credentials metadata used to fetch groups from the identity provider.

BastionZero API docs: https://cloud.bastionzero.com/api/#delete-/api/v2/organization/groups/credentials

func (*OrganizationService) DisableGlobalRegistrationKey

func (s *OrganizationService) DisableGlobalRegistrationKey(ctx context.Context) (*RegistrationKeySettings, *http.Response, error)

DisableGlobalRegistrationKey disables global registration key enforcement for your BastionZero organization.

BastionZero API docs: https://cloud.bastionzero.com/api/#post-/api/v2/organization/registration-key/disable-enforce-global-key

func (*OrganizationService) EnableGlobalRegistrationKey

func (s *OrganizationService) EnableGlobalRegistrationKey(ctx context.Context, request *EnableGlobalRegistrationKeyRequest) (*RegistrationKeySettings, *http.Response, error)

EnableGlobalRegistrationKey enables global registration key enforcement for your BastionZero organization. If enabled, the global registration key is the only key that can be used for registering targets.

BastionZero API docs: https://cloud.bastionzero.com/api/#post-/api/v2/organization/registration-key/enable-enforce-global-key

func (*OrganizationService) FetchGroups

func (s *OrganizationService) FetchGroups(ctx context.Context) ([]Group, *http.Response, error)

FetchGroups fetches the groups for your organization by querying the configured identity provider directly.

BastionZero API docs: https://cloud.bastionzero.com/api/#post-/api/v2/organization/groups/fetch

func (*OrganizationService) FetchUserGroups

func (s *OrganizationService) FetchUserGroups(ctx context.Context, userID string) ([]Group, *http.Response, error)

FetchUserGroups fetches the groups for the specified user by querying the configured identity provider directly.

BastionZero API docs: https://cloud.bastionzero.com/api/#post-/api/v2/organization/groups-memberships/fetch/-id-

func (*OrganizationService) GetBZCertValidationInfo

func (s *OrganizationService) GetBZCertValidationInfo(ctx context.Context) (*BZCertValidationInfo, *http.Response, error)

GetBZCertValidationInfo gets information needed to validate BZCerts issued for your BastionZero organization.

BastionZero API docs: https://cloud.bastionzero.com/api/#get-/api/v2/organization/bzcert-validation-info

func (*OrganizationService) GetIdentityProvider

func (s *OrganizationService) GetIdentityProvider(ctx context.Context) (*IdentityProvider, *http.Response, error)

GetIdentityProvider gets identity provider details for your BastionZero organization.

BastionZero API docs: https://cloud.bastionzero.com/api/#get-/api/v2/organization/identity-provider

func (*OrganizationService) GetOrganization

func (s *OrganizationService) GetOrganization(ctx context.Context) (*Organization, *http.Response, error)

GetOrganization gets information about your BastionZero organization.

BastionZero API docs: https://cloud.bastionzero.com/api/#get-/api/v2/organization

func (*OrganizationService) GetRegistrationKeySettings

func (s *OrganizationService) GetRegistrationKeySettings(ctx context.Context) (*RegistrationKeySettings, *http.Response, error)

GetRegistrationKeySettings gets information about the registration key settings for your BastionZero organization.

BastionZero API docs: https://cloud.bastionzero.com/api/#get-/api/v2/organization/registration-key/settings

func (*OrganizationService) GetSlackIntegration

func (s *OrganizationService) GetSlackIntegration(ctx context.Context) (*SlackIntegration, *http.Response, error)

GetSlackIntegration gets information about the Slack integration with your BastionZero organization.

BastionZero API docs: https://cloud.bastionzero.com/api/#get-/api/v2/organization/integrations/slack

func (*OrganizationService) InvalidateKeycloakProviderCache

func (s *OrganizationService) InvalidateKeycloakProviderCache(ctx context.Context) (*http.Response, error)

InvalidateKeycloakProviderCache invalidates the Keycloak provider cache entry.

BastionZero API docs: https://cloud.bastionzero.com/api/#post-/api/v2/organization/invalidate-keycloak

func (*OrganizationService) ListGroups

func (s *OrganizationService) ListGroups(ctx context.Context) ([]Group, *http.Response, error)

ListGroups lists the groups configured (synced from IdP) for your organization.

BastionZero API docs: https://cloud.bastionzero.com/api/#get-/api/v2/organization/groups

type RegistrationKeySettings

type RegistrationKeySettings struct {
	GlobalRegistrationKeyEnforced bool    `json:"globalRegistrationKeyEnforced"`
	DefaultGlobalRegistrationKey  *string `json:"defaultGlobalRegistrationKey"`
}

RegistrationKeySettings contains information about one's BastionZero organization's registration key settings used in the autodiscovery process.

type SlackIntegration

type SlackIntegration struct {
	TeamName       string          `json:"teamName"`
	AdminEmail     string          `json:"adminEmail"`
	CreationDate   types.Timestamp `json:"creationDate"`
	LastUpdateDate types.Timestamp `json:"lastUpdateDate"`
}

SlackIntegration contains details about a Slack integration with one's BastionZero organization.