ad

Documentation

Index

• Constants
• type ADErr
• type AddUser
• type Args
• type AzureGroup
• type AzureUser
• type CreateADGroup
• type CreateADGroupResponse
• type CreateADUser
• type GroupMembers
• type GroupNotFoundError
  • func (e *GroupNotFoundError) Error() string
• type ListGroupsResponse
• type ListUsersResponse
• type PasswordProfile
• type Provider
  • func (c *Provider) AddUserToGroup(ctx context.Context, userID string, groupID string) error
  • func (p *Provider) ArgSchema() providers.ArgSchema
  • func (a *Provider) Config() gconfig.Config
  • func (c *Provider) CreateGroup(ctx context.Context, group CreateADGroup) (*CreateADGroupResponse, error)
  • func (c *Provider) CreateUser(ctx context.Context, user CreateADUser) error
  • func (c *Provider) DeleteGroup(ctx context.Context, groupID string) error
  • func (c *Provider) DeleteUser(ctx context.Context, userID string) error
  • func (c *Provider) GetGroup(ctx context.Context, groupID string) (*AzureGroup, error)
  • func (c *Provider) GetUser(ctx context.Context, userID string) (*AzureUser, error)
  • func (p *Provider) Grant(ctx context.Context, subject string, args []byte, grantID string) error
  • func (a *Provider) Init(ctx context.Context) error
  • func (p *Provider) IsActive(ctx context.Context, subject string, args []byte, grantID string) (bool, error)
  • func (c *Provider) ListGroupUsers(ctx context.Context, groupID string) ([]AzureUser, error)
  • func (c *Provider) ListGroups(context.Context) ([]AzureGroup, error)
  • func (c *Provider) ListUsers(ctx context.Context) ([]AzureUser, error)
  • func (p *Provider) Options(ctx context.Context, arg string) (*types.ArgOptionsResponse, error)
  • func (c *Provider) RemoveUserFromGroup(ctx context.Context, userID string, groupID string) error
  • func (p *Provider) Revoke(ctx context.Context, subject string, args []byte, grantID string) error
  • func (p *Provider) SetupDocs() embed.FS
  • func (p *Provider) TestConfig(ctx context.Context) error
  • func (p *Provider) ValidateConfig() map[string]providers.ConfigValidationStep
  • func (p *Provider) ValidateGrant() providers.GrantValidationSteps
• type UserGroups
• type UserNotFoundError
  • func (e *UserNotFoundError) Error() string

Constants

const ADAuthorityHost = "https://login.microsoftonline.com"

const MSGraphBaseURL = "https://graph.microsoft.com/v1.0"

Types

type ADErr

type ADErr struct {
	Error struct {
		Code       string `json:"code"`
		Message    string `json:"message"`
		InnerError struct {
			Date            string `json:"date"`
			RequestID       string `json:"request-id"`
			ClientRequestID string `json:"client-request-id"`
		} `json:"innerError"`
	} `json:"error"`
}

type AddUser

type AddUser struct {
	Key string `json:"@odata.id"`
}

type Args

type Args struct {
	GroupID string `json:"groupId"`
}

type AzureGroup

type AzureGroup struct {
	ID          string `json:"id"`
	Description string `json:"description"`
	DisplayName string `json:"displayName"`
}

type AzureUser

type AzureUser struct {
	GivenName string `json:"givenName"`
	Mail      string `json:"mail"`
	Surname   string `json:"surname"`
	ID        string `json:"id"`
}

type CreateADGroup

type CreateADGroup struct {
	Description     string   `json:"description"`
	DisplayName     string   `json:"displayName"`
	GroupTypes      []string `json:"groupTypes"`
	MailEnabled     bool     `json:"mailEnabled"`
	MailNickname    string   `json:"mailNickname"`
	SecurityEnabled bool     `json:"securityEnabled"`
}

type CreateADGroupResponse

type CreateADGroupResponse struct {
	ID string `json:"id"`

	Description string `json:"description"`
	DisplayName string `json:"displayName"`
}

type CreateADUser

type CreateADUser struct {
	AccountEnabled    bool            `json:"accountEnabled"`
	DisplayName       string          `json:"displayName"`
	MailNickname      string          `json:"mailNickname"`
	UserPrincipalName string          `json:"userPrincipalName"`
	PasswordProfile   PasswordProfile `json:"passwordProfile"`
}

type GroupMembers

type GroupMembers struct {
	OdataNextLink *string  `json:"@odata.nextLink,omitempty"`
	OdataContext  string   `json:"@odata.context"`
	Value         []string `json:"value"`
}

type GroupNotFoundError

type GroupNotFoundError struct {
	Group string
}

func (*GroupNotFoundError) Error

func (e *GroupNotFoundError) Error() string

type ListGroupsResponse

type ListGroupsResponse struct {
	OdataContext  string       `json:"@odata.context"`
	OdataNextLink *string      `json:"@odata.nextLink,omitempty"`
	Value         []AzureGroup `json:"value"`
}

type ListUsersResponse

type ListUsersResponse struct {
	OdataContext  string      `json:"@odata.context"`
	OdataNextLink *string     `json:"@odata.nextLink,omitempty"`
	Value         []AzureUser `json:"value"`
}

type PasswordProfile

type PasswordProfile struct {
	ForceChangePasswordNextSignIn bool   `json:"forceChangePasswordNextSignIn"`
	Password                      string `json:"password"`
}

type Provider

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

func (*Provider) AddUserToGroup

func (c *Provider) AddUserToGroup(ctx context.Context, userID string, groupID string) error

GroupMember.ReadWrite.All

func (*Provider) ArgSchema

func (p *Provider) ArgSchema() providers.ArgSchema

func (*Provider) Config

func (a *Provider) Config() gconfig.Config

func (*Provider) CreateGroup

func (c *Provider) CreateGroup(ctx context.Context, group CreateADGroup) (*CreateADGroupResponse, error)

func (*Provider) CreateUser

func (c *Provider) CreateUser(ctx context.Context, user CreateADUser) error

func (*Provider) DeleteGroup

func (c *Provider) DeleteGroup(ctx context.Context, groupID string) error

func (*Provider) DeleteUser

func (c *Provider) DeleteUser(ctx context.Context, userID string) error

func (*Provider) GetGroup

func (c *Provider) GetGroup(ctx context.Context, groupID string) (*AzureGroup, error)

func (*Provider) GetUser

func (c *Provider) GetUser(ctx context.Context, userID string) (*AzureUser, error)

func (*Provider) Grant

func (p *Provider) Grant(ctx context.Context, subject string, args []byte, grantID string) error

Grant the access by calling azure's API.

func (*Provider) Init

func (a *Provider) Init(ctx context.Context) error

Init the Azure provider.

func (*Provider) IsActive

func (p *Provider) IsActive(ctx context.Context, subject string, args []byte, grantID string) (bool, error)

IsActive checks whether the access is active by calling Azure AD's API.

func (*Provider) ListGroupUsers

func (c *Provider) ListGroupUsers(ctx context.Context, groupID string) ([]AzureUser, error)

GroupMember.Read.All

func (*Provider) ListGroups

func (c *Provider) ListGroups(context.Context) ([]AzureGroup, error)

func (*Provider) ListUsers

func (c *Provider) ListUsers(ctx context.Context) ([]AzureUser, error)

func (*Provider) Options

func (p *Provider) Options(ctx context.Context, arg string) (*types.ArgOptionsResponse, error)

List options for arg

func (*Provider) RemoveUserFromGroup

func (c *Provider) RemoveUserFromGroup(ctx context.Context, userID string, groupID string) error

GroupMember.ReadWrite.All

func (*Provider) Revoke

func (p *Provider) Revoke(ctx context.Context, subject string, args []byte, grantID string) error

Revoke the access by calling Azure AD's API.

func (*Provider) SetupDocs

func (p *Provider) SetupDocs() embed.FS

SetupDocs returns the embedded filesystem containing setup documentation.

func (*Provider) TestConfig

func (p *Provider) TestConfig(ctx context.Context) error

func (*Provider) ValidateConfig

func (p *Provider) ValidateConfig() map[string]providers.ConfigValidationStep

func (*Provider) ValidateGrant

func (p *Provider) ValidateGrant() providers.GrantValidationSteps

type UserGroups

type UserGroups struct {
	OdataNextLink *string  `json:"@odata.nextLink,omitempty"`
	OdataContext  string   `json:"@odata.context"`
	Value         []string `json:"value"`
}

type UserNotFoundError

type UserNotFoundError struct {
	User string
}

func (*UserNotFoundError) Error

func (e *UserNotFoundError) Error() string