common

Documentation

Index

• Constants

Constants

const (
	// IndentPrefix is the beginning of all Indent types.
	IndentPrefix = "indent.com/"

	// IndentKind represents the type of a block.
	IndentKind = IndentPrefix + "kind"

	// LabelSchema identifies the schema for the structure that backs a block.
	LabelSchema = IndentPrefix + "schema"

	// LabelDescription provides an excerpt for a Resource.
	LabelDescription = "description"

	// LabelReason provides a comma-delimited list of example reasons for a Resource.
	LabelReason = "reason"

	// LabelSource contains the Source of the command.
	LabelSource = "indent.com/app/cmd/source"
)

const (
	// LabelKindPetitionAppValue is the value of the kind label for a block.
	LabelKindPetitionAppValue = "indent.blocks.provider.v1.App"

	// LabelAppConfigID determines the app used to resolve a petition.
	LabelAppConfigID = "indent.com/app/config/id"

	// LabelSpecifiedPetitionDuration is the duration value submitted by the petitioner.
	LabelSpecifiedPetitionDuration = "indent.com/petition/duration"
)

const (
	// EventApprove is the event for when a request is approved.
	EventApprove = "access/approve"

	// EventDeny is the event for when a request is denied.
	EventDeny = "access/deny"

	// EventGrant is the event produced when a permission is granted.
	EventGrant = "access/grant"

	// EventRevoke is the event produced when a permission is revoked.
	EventRevoke = "access/revoke"
)

const (
	// LabelExpires contains a Time specifying the expiration of a resource.
	LabelExpires = IndentPrefix + "time/expires"

	// LabelDuration contains a length of time.
	LabelDuration = IndentPrefix + "time/duration"

	// LabelIsIndefinite is a boolean label indicating whether a claim approves
	// indefinite access.
	LabelIsIndefinite = IndentPrefix + "time/indefinite"
)

const (
	// HeaderSignature contains the signature used to sign a message from Indent.
	HeaderSignature = "X-Indent-Signature"

	// HeaderTimestamp contains a timestamp associated with a signature.
	HeaderTimestamp = "X-Indent-Timestamp"
)

const (
	// BitSize32 represents 32-bit numbers.
	BitSize32 = 32

	// BitSize64 represents 64-bit numbers.
	BitSize64 = 64
)

const (
	// KindOktaUser is for resources that represent Okta users.
	KindOktaUser = OktaPrefix + "User"

	// KindOktaAppUser is for resources that represent Okta app users.
	KindOktaAppUser = OktaPrefix + "AppUser"

	// KindOktaGroup is for resources that represent Okta groups.
	KindOktaGroup = OktaPrefix + "Group"
)

const (
	// PetitionStateOpen denotes the "open" petition state. See [docs](https://indent.dev/docs/petitions#petition-phases).
	PetitionStateOpen = "open"
	// PetitionStateGranted denotes the "granted" petition state. See [docs](https://indent.dev/docs/petitions#petition-phases).
	PetitionStateGranted = "granted"
	// PetitionStateRevoked denotes the "revoked" petition state. See [docs](https://indent.dev/docs/petitions#petition-phases).
	PetitionStateRevoked = "revoked"
	// PetitionStateClosed denotes the "closed" petition state. See [docs](https://indent.dev/docs/petitions#petition-phases).
	PetitionStateClosed = "closed"
)

const (
	// LabelPetitionReplacesID is the label containing the petition that a given petition replaces
	LabelPetitionReplacesID = "PetitionReplaces"
	// LabelPetitionReplacedByID is the label containing the petition that a given petition was replaced by
	LabelPetitionReplacedByID = "PetitionReplacedBy"
)

const (
	// LabelResourceEmail contains the email associated with Resource.
	LabelResourceEmail = ResourcePrefix + "email"

	// LabelResourceKind contains the kind associated with Resource.
	LabelResourceKind = ResourcePrefix + "kind"

	// LabelResourceID contains the ID associated with Resource.
	LabelResourceID = ResourcePrefix + "id"

	// LabelResourceIconURL contains the icon URL associated with Resource.
	LabelResourceIconURL = ResourcePrefix + "icon"

	// LabelIsDeactivated indicates whether a user Resource has been deactivated
	LabelIsDeactivated = ResourcePrefix + "is_deactivated"
)

const (
	// KindSlackUser is for resources that represent Slack users.
	KindSlackUser = SlackPrefix + "user"

	// KindSlackConversation represents a Slack chat.
	KindSlackConversation = SlackPrefix + "conversation"
)

const (
	// SlackConversationTypePrivateChannel represents a private Slack channel.
	SlackConversationTypePrivateChannel = "private_channel"

	// SlackConversationTypePublicChannel represents a public Slack channel.
	SlackConversationTypePublicChannel = "public_channel"
)

const (
	// LabelTeamID contains the ID of the related team.
	LabelTeamID = SlackPrefix + "team/id"

	// LabelSlackIsAdmin indicates whether a Slack user is a workspace admin.
	LabelSlackIsAdmin = SlackPrefix + "is_admin"
	// LabelSlackIsOwner indicates whether a Slack user is a workspace owner.
	LabelSlackIsOwner = SlackPrefix + "is_owner"
	// LabelSlackIsPrimaryOwner indicates whether a Slack user is the primary workspace owner.
	LabelSlackIsPrimaryOwner = SlackPrefix + "is_primary_owner"
	// LabelSlackIsRestricted indicates whether a Slack user is restricted.
	LabelSlackIsRestricted = SlackPrefix + "is_restricted"
	// LabelSlackIsUltraRestricted indicates whether a Slack user is ultra-restricted.
	LabelSlackIsUltraRestricted = SlackPrefix + "is_ultra_restricted"
	// LabelSlackIsDeactivated indicates whether a Slack user has been deactivated
	// or deleted; Slack uses these terms interchangeably: api.slack.com/types/user
	LabelSlackIsDeactivated = SlackPrefix + "is_deactivated"
	// LabelSlackIsBot indicates whether a Slack user is a bot.
	LabelSlackIsBot = SlackPrefix + "is_bot"
	// LabelSlackHas2FA indicates whether a Slack user has 2FA configured.
	LabelSlackHas2FA = SlackPrefix + "has_2fa"
)

const (
	// ViewPeople is the view id for listing all human users in a space.
	ViewPeople = "people"

	// ViewEmail is the view id for listing all user emails in a space.
	ViewEmail = "email"

	// ViewRequestable is the view id for listing requestable resources.
	ViewRequestable = "requestable"

	// ViewRecipients is the view id for listing potential recipients of access.
	ViewRecipients = "recipients"

	// ViewRequestableModal is the view id for listing requestable resources in a modal.
	ViewRequestableModal = ViewRequestable + ":modal"
)

const (
	// Base10 represents decimal numbers.
	Base10 = 10
)

const (
	// EnvIndentSpace is the name of the space affected.
	EnvIndentSpace = "INDENT_SPACE"
)

Names for environment variables used as cmd/indent-api configuration.

const (
	// KindPetition is the kind representing a Petition.
	KindPetition = "indent.v1.Petition"
)

const (
	// KindRole is a Role within Indent that can be assigned to a user.
	KindRole = "indent.v1.Role"
)

const (
	// KindUser is the resource kind for an Indent user resource.
	KindUser = "indent.blocks.v1.User"
)

const (
	// LabelBlockName is the label used to define a messages Block name.
	LabelBlockName = "indent.com/block"
)

const (
	// LabelManager is the manager of the given resource.
	LabelManager = "managerId"
)

const (
	// LabelOktaID label containing the Okta ID related to a Resource.
	LabelOktaID = "oktaId"
)

const (
	// LabelResourceAutoApproval indicates that the resource is auto-approved.
	LabelResourceAutoApproval = "auto_approval"
)

const (
	// LabelSlackManager contains the Slack ID of a user's manager.
	LabelSlackManager = SlackPrefix + LabelManager
)

const (
	// LabelView contains a view to be returned.
	LabelView = "resource.indentapis.com/v1/ResourcePolicy.view"
)

const (
	// MinLenReason is the shortest length accepted for a reason
	MinLenReason = 5
)

const (
	// OktaPrefix is the beginning of all of Okta kinds.
	OktaPrefix = "okta.v1."
)

const (
	// ResourcePrefix begins each resource label.
	ResourcePrefix = IndentPrefix + "resource/"
)

const (
	// ResourceSchema tracks the version of the Resource schema.
	ResourceSchema = "indent.audit.v1beta1.Resource"
)

const (
	// SlackPrefix is the beginning of all of Slack kinds.
	SlackPrefix = "slack/"
)

const (
	// SourceSlack is the Source when a Petition is received by Slack.
	SourceSlack = "Slack"
)

const (
	// StateLen is the length of the OAuth2 'state' string.
	StateLen = 24
)

const (
	// TimeoutPetitionList is the maximum time to wait for listing petitions.
	TimeoutPetitionList = 9 * time.Second
)