authorizationjuice

Documentation

Index

• Constants
• type AuthorizeMany
  • func NewAuthorizeMany(entityIDs []primitive.ObjectID, principalID primitive.ObjectID, role int64) *AuthorizeMany
  • func (a *AuthorizeMany) GetEntityIDs() []primitive.ObjectID
  • func (a *AuthorizeMany) GetPrincipalID() primitive.ObjectID
  • func (a *AuthorizeMany) GetRole() int64
  • func (a *AuthorizeMany) SetEntityIDs(entityIDs []primitive.ObjectID)
  • func (a *AuthorizeMany) SetPrincipalID(principalID primitive.ObjectID)
  • func (a *AuthorizeMany) SetRole(role int64)
• type AuthorizeManyResponse
• type AuthorizeResponse
• type Key
• type StructTag

Constants

const (
	// Struct tags.
	RoleIntRange StructTag = "roleintrange"

	// Various keys.
	EntityIDsKey         Key = "entity_ids"
	EntityIDKey          Key = "entity_id"
	PrincipalIDKey       Key = "principal_id"
	RoleKey              Key = "role"
	UnallowedEntitiesKey Key = "unallowed_entities"
)

Types

type AuthorizeMany

type AuthorizeMany struct {
	// A list of MongoDB Object IDs representing the entities to be authorized.
	// example: [5f8f9a9a9a9a9a9a9a9a9a9a, 5f8f9a9a9a9a9a9a9a9a9a9a]
	// required: true
	EntityIDs *[]primitive.ObjectID `json:"entity_ids" validate:"nonnilpointer"`

	// The MongoDB Object ID of the principal being authorized to access the entities.
	// example: 5f8f9a9a9a9a9a9a9a9a9a9a
	// required: true
	PrincipalID *primitive.ObjectID `json:"principal_id" validate:"nonnilpointer,nonzeropointerelem"`

	// The role assigned to the principal for the authorized entities. Must be a valid integer role as defined in authorization microservice.
	// example: 1
	// required: true
	Role *int64 `json:"role" validate:"nonnilpointer,roleintrange"`
}

AuthorizeMany represents the payload required to authorize multiple entities. swagger:model

func NewAuthorizeMany

func NewAuthorizeMany(
	entityIDs []primitive.ObjectID,
	principalID primitive.ObjectID,
	role int64,
) *AuthorizeMany

func (*AuthorizeMany) GetEntityIDs

func (a *AuthorizeMany) GetEntityIDs() []primitive.ObjectID

func (*AuthorizeMany) GetPrincipalID

func (a *AuthorizeMany) GetPrincipalID() primitive.ObjectID

func (*AuthorizeMany) GetRole

func (a *AuthorizeMany) GetRole() int64

func (*AuthorizeMany) SetEntityIDs

func (a *AuthorizeMany) SetEntityIDs(entityIDs []primitive.ObjectID)

func (*AuthorizeMany) SetPrincipalID

func (a *AuthorizeMany) SetPrincipalID(principalID primitive.ObjectID)

func (*AuthorizeMany) SetRole

func (a *AuthorizeMany) SetRole(role int64)

type AuthorizeManyResponse

type AuthorizeManyResponse struct {
	// The unauthorized entity IDs.
	// example: [5f6d4b9b9c6f9f0001b9c6f9]
	UnallowedEntities []primitive.ObjectID `json:"unallowed_entities"`
}

AuthorizeManyResponse represents an authorization response for the authorization of multiple entities where a list of unauthorized entity IDs is returned. swagger:model

type AuthorizeResponse

type AuthorizeResponse struct {
	// The status code.
	// example: 200
	Code int `json:"code"`
}

AuthorizeResponse represents an authorization response for a single entity where a simple status code is returned. swagger:model

type Key

type Key = string

Aliases.

type StructTag

type StructTag = string

Aliases.