Documentation
¶
Overview ¶
Package auth0 is a generated GoMock package.
Package auth0 is a generated GoMock package.
Package auth0 is a generated GoMock package.
Package auth0 is a generated GoMock package.
Index ¶
- Variables
- func Error(e error, message string) error
- type API
- type ActionAPI
- type AnomalyAPI
- type BrandingAPI
- type ClientAPI
- type ConnectionAPI
- type CustomDomainAPI
- type EmailTemplateAPI
- type LogAPI
- type LogStreamAPI
- type MockClientAPI
- func (m *MockClientAPI) Create(c *management.Client, opts ...management.RequestOption) error
- func (m *MockClientAPI) Delete(id string, opts ...management.RequestOption) error
- func (m *MockClientAPI) EXPECT() *MockClientAPIMockRecorder
- func (m *MockClientAPI) List(opts ...management.RequestOption) (*management.ClientList, error)
- func (m *MockClientAPI) Read(id string, opts ...management.RequestOption) (*management.Client, error)
- func (m *MockClientAPI) RotateSecret(id string, opts ...management.RequestOption) (*management.Client, error)
- func (m *MockClientAPI) Update(id string, c *management.Client, opts ...management.RequestOption) error
- type MockClientAPIMockRecorder
- func (mr *MockClientAPIMockRecorder) Create(c interface{}, opts ...interface{}) *gomock.Call
- func (mr *MockClientAPIMockRecorder) Delete(id interface{}, opts ...interface{}) *gomock.Call
- func (mr *MockClientAPIMockRecorder) List(opts ...interface{}) *gomock.Call
- func (mr *MockClientAPIMockRecorder) Read(id interface{}, opts ...interface{}) *gomock.Call
- func (mr *MockClientAPIMockRecorder) RotateSecret(id interface{}, opts ...interface{}) *gomock.Call
- func (mr *MockClientAPIMockRecorder) Update(id, c interface{}, opts ...interface{}) *gomock.Call
- type MockLogAPI
- func (m *MockLogAPI) EXPECT() *MockLogAPIMockRecorder
- func (m *MockLogAPI) List(opts ...management.RequestOption) ([]*management.Log, error)
- func (m *MockLogAPI) Read(id string, opts ...management.RequestOption) (*management.Log, error)
- func (m *MockLogAPI) Search(opts ...management.RequestOption) ([]*management.Log, error)
- type MockLogAPIMockRecorder
- type MockResourceServerAPI
- func (m *MockResourceServerAPI) Create(rs *management.ResourceServer, opts ...management.RequestOption) error
- func (m *MockResourceServerAPI) Delete(id string, opts ...management.RequestOption) error
- func (m *MockResourceServerAPI) EXPECT() *MockResourceServerAPIMockRecorder
- func (m *MockResourceServerAPI) List(opts ...management.RequestOption) (*management.ResourceServerList, error)
- func (m *MockResourceServerAPI) Read(id string, opts ...management.RequestOption) (*management.ResourceServer, error)
- func (m *MockResourceServerAPI) Stream(fn func(*management.ResourceServer), opts ...management.RequestOption) error
- func (m *MockResourceServerAPI) Update(id string, rs *management.ResourceServer, opts ...management.RequestOption) error
- type MockResourceServerAPIMockRecorder
- func (mr *MockResourceServerAPIMockRecorder) Create(rs interface{}, opts ...interface{}) *gomock.Call
- func (mr *MockResourceServerAPIMockRecorder) Delete(id interface{}, opts ...interface{}) *gomock.Call
- func (mr *MockResourceServerAPIMockRecorder) List(opts ...interface{}) *gomock.Call
- func (mr *MockResourceServerAPIMockRecorder) Read(id interface{}, opts ...interface{}) *gomock.Call
- func (mr *MockResourceServerAPIMockRecorder) Stream(fn interface{}, opts ...interface{}) *gomock.Call
- func (mr *MockResourceServerAPIMockRecorder) Update(id, rs interface{}, opts ...interface{}) *gomock.Call
- type MockRuleAPI
- func (m *MockRuleAPI) Create(r *management.Rule, opts ...management.RequestOption) error
- func (m *MockRuleAPI) Delete(id string, opts ...management.RequestOption) error
- func (m *MockRuleAPI) EXPECT() *MockRuleAPIMockRecorder
- func (m *MockRuleAPI) List(opts ...management.RequestOption) (*management.RuleList, error)
- func (m *MockRuleAPI) Read(id string, opts ...management.RequestOption) (*management.Rule, error)
- func (m *MockRuleAPI) Update(id string, r *management.Rule, opts ...management.RequestOption) error
- type MockRuleAPIMockRecorder
- func (mr *MockRuleAPIMockRecorder) Create(r interface{}, opts ...interface{}) *gomock.Call
- func (mr *MockRuleAPIMockRecorder) Delete(id interface{}, opts ...interface{}) *gomock.Call
- func (mr *MockRuleAPIMockRecorder) List(opts ...interface{}) *gomock.Call
- func (mr *MockRuleAPIMockRecorder) Read(id interface{}, opts ...interface{}) *gomock.Call
- func (mr *MockRuleAPIMockRecorder) Update(id, r interface{}, opts ...interface{}) *gomock.Call
- type OrganizationAPI
- type Quickstart
- type ResourceServerAPI
- type RoleAPI
- type RuleAPI
- type TenantAPI
- type UserAPI
Constants ¶
This section is empty.
Variables ¶
var ( Bool = auth0.Bool BoolValue = auth0.BoolValue String = auth0.String StringValue = auth0.StringValue Int = auth0.Int IntValue = auth0.IntValue Float64 = auth0.Float64 Float64Value = auth0.Float64Value Time = auth0.Time TimeValue = auth0.TimeValue )
Alias all the helper methods so we can keep just typing `auth0.Bool` and the compiler can autocomplete our internal package.
Functions ¶
Types ¶
type API ¶
type API struct {
Action ActionAPI
Anomaly AnomalyAPI
Branding BrandingAPI
Client ClientAPI
Connection ConnectionAPI
CustomDomain CustomDomainAPI
EmailTemplate EmailTemplateAPI
Log LogAPI
LogStream LogStreamAPI
Organization OrganizationAPI
ResourceServer ResourceServerAPI
Role RoleAPI
Rule RuleAPI
Tenant TenantAPI
User UserAPI
}
API mimics `management.Management`s general interface, except it refers to the interfaces instead of the concrete structs.
func NewAPI ¶
func NewAPI(m *management.Management) *API
type ActionAPI ¶
type ActionAPI interface {
// Create a new action.
//
// See: https://auth0.com/docs/api/management/v2#!/Actions/post_action
Create(a *management.Action, opts ...management.RequestOption) error
// Retrieve action details.
//
// See: https://auth0.com/docs/api/management/v2#!/Actions/get_action
Read(id string, opts ...management.RequestOption) (*management.Action, error)
// Update an existing action.
//
// See: https://auth0.com/docs/api/management/v2#!/Actions/patch_action
Update(id string, a *management.Action, opts ...management.RequestOption) error
// Delete an action
//
// See: https://auth0.com/docs/api/management/v2#!/Actions/delete_action
Delete(id string, opts ...management.RequestOption) error
// List all actions.
//
// See: https://auth0.com/docs/api/management/v2#!/Actions/get_actions
List(opts ...management.RequestOption) (c *management.ActionList, err error)
// ListTriggers available.
//
// https://auth0.com/docs/api/management/v2/#!/Actions/get_triggers
ListTriggers(opts ...management.RequestOption) (l *management.ActionTriggerList, err error)
}
type AnomalyAPI ¶ added in v0.7.0
type AnomalyAPI interface {
// Check if a given IP address is blocked via the multiple user accounts
// trigger due to multiple failed logins.
//
// See: https://auth0.com/docs/api/management/v2#!/Anomaly/get_ips_by_id
CheckIP(ip string, opts ...management.RequestOption) (isBlocked bool, err error)
// Unblock an IP address currently blocked by the multiple user accounts
// trigger due to multiple failed logins.
//
// See: https://auth0.com/docs/api/management/v2#!/Anomaly/delete_ips_by_id
UnblockIP(ip string, opts ...management.RequestOption) (err error)
}
type BrandingAPI ¶ added in v0.6.0
type BrandingAPI interface {
Read(opts ...management.RequestOption) (b *management.Branding, err error)
Update(t *management.Branding, opts ...management.RequestOption) (err error)
UniversalLogin(opts ...management.RequestOption) (ul *management.BrandingUniversalLogin, err error)
SetUniversalLogin(ul *management.BrandingUniversalLogin, opts ...management.RequestOption) (err error)
DeleteUniversalLogin(opts ...management.RequestOption) (err error)
}
type ClientAPI ¶
type ClientAPI interface {
// Create a new client application.
Create(c *management.Client, opts ...management.RequestOption) (err error)
// Read a client by its id.
Read(id string, opts ...management.RequestOption) (c *management.Client, err error)
// List all client applications.
List(opts ...management.RequestOption) (c *management.ClientList, err error)
// Update a client.
Update(id string, c *management.Client, opts ...management.RequestOption) (err error)
// RotateSecret rotates a client secret.
RotateSecret(id string, opts ...management.RequestOption) (c *management.Client, err error)
// Delete a client and all its related assets (like rules, connections, etc)
// given its id.
Delete(id string, opts ...management.RequestOption) error
}
type ConnectionAPI ¶ added in v0.7.0
type ConnectionAPI interface {
// Create a new connection.
Create(c *management.Connection, opts ...management.RequestOption) (err error)
// Read retrieves a connection by its id.
Read(id string, opts ...management.RequestOption) (c *management.Connection, err error)
// ReadByName retrieves a connection by its name.
ReadByName(id string, opts ...management.RequestOption) (c *management.Connection, err error)
// Update a connection.
Update(id string, c *management.Connection, opts ...management.RequestOption) (err error)
// Delete a connection.
Delete(id string, opts ...management.RequestOption) (err error)
// List all connections.
List(opts ...management.RequestOption) (ul *management.ConnectionList, err error)
}
type CustomDomainAPI ¶ added in v0.6.0
type CustomDomainAPI interface {
// Create a new custom domain.
Create(c *management.CustomDomain, opts ...management.RequestOption) (err error)
// Read retrieves a custom domain by its id.
Read(id string, opts ...management.RequestOption) (c *management.CustomDomain, err error)
// Update a custom domain.
Update(id string, c *management.CustomDomain, opts ...management.RequestOption) (err error)
// Delete a custom domain.
Delete(id string, opts ...management.RequestOption) (err error)
// Verify a custom domain.
Verify(id string, opts ...management.RequestOption) (c *management.CustomDomain, err error)
// List all custom domains.
List(opts ...management.RequestOption) (c []*management.CustomDomain, err error)
}
type EmailTemplateAPI ¶ added in v0.9.1
type EmailTemplateAPI interface {
// Retrieve an email template by pre-defined name.
//
// These names are `verify_email`, `reset_email`, `welcome_email`,
// `blocked_account`, `stolen_credentials`, `enrollment_email`, and
// `mfa_oob_code`.
//
// The names `change_password`, and `password_reset` are also supported for
// legacy scenarios.
//
// See: https://auth0.com/docs/api/management/v2#!/Email_Templates/get_email_templates_by_templateName
Read(template string, opts ...management.RequestOption) (e *management.EmailTemplate, err error)
// Modify an email template.
//
// See: https://auth0.com/docs/api/management/v2#!/Email_Templates/patch_email_templates_by_templateName
Update(template string, e *management.EmailTemplate, opts ...management.RequestOption) (err error)
}
type LogAPI ¶
type LogAPI interface {
// Retrieves the data related to the log entry identified by id. This returns a
// single log entry representation as specified in the schema.
Read(id string, opts ...management.RequestOption) (l *management.Log, err error)
// List all log entries that match the specified search criteria (or lists all
// log entries if no criteria are used). Set custom search criteria using the
// `q` parameter, or search from a specific log id ("search from checkpoint").
//
// For more information on all possible event types, their respective acronyms
// and descriptions, Log Data Event Listing.
List(opts ...management.RequestOption) (l []*management.Log, err error)
// Search is an alias for List
Search(opts ...management.RequestOption) ([]*management.Log, error)
}
type LogStreamAPI ¶ added in v0.8.0
type LogStreamAPI interface {
// Create a log stream.
Create(ls *management.LogStream, opts ...management.RequestOption) (err error)
// Read a log stream.
Read(id string, opts ...management.RequestOption) (ls *management.LogStream, err error)
// Update a log stream.
Update(id string, ls *management.LogStream, opts ...management.RequestOption) (err error)
// List all log streams.
List(opts ...management.RequestOption) (ls []*management.LogStream, err error)
// Delete a log stream.
Delete(id string, opts ...management.RequestOption) (err error)
}
type MockClientAPI ¶
type MockClientAPI struct {
// contains filtered or unexported fields
}
MockClientAPI is a mock of ClientAPI interface
func NewMockClientAPI ¶
func NewMockClientAPI(ctrl *gomock.Controller) *MockClientAPI
NewMockClientAPI creates a new mock instance
func (*MockClientAPI) Create ¶
func (m *MockClientAPI) Create(c *management.Client, opts ...management.RequestOption) error
Create mocks base method
func (*MockClientAPI) Delete ¶
func (m *MockClientAPI) Delete(id string, opts ...management.RequestOption) error
Delete mocks base method
func (*MockClientAPI) EXPECT ¶
func (m *MockClientAPI) EXPECT() *MockClientAPIMockRecorder
EXPECT returns an object that allows the caller to indicate expected use
func (*MockClientAPI) List ¶
func (m *MockClientAPI) List(opts ...management.RequestOption) (*management.ClientList, error)
List mocks base method
func (*MockClientAPI) Read ¶
func (m *MockClientAPI) Read(id string, opts ...management.RequestOption) (*management.Client, error)
Read mocks base method
func (*MockClientAPI) RotateSecret ¶
func (m *MockClientAPI) RotateSecret(id string, opts ...management.RequestOption) (*management.Client, error)
RotateSecret mocks base method
func (*MockClientAPI) Update ¶
func (m *MockClientAPI) Update(id string, c *management.Client, opts ...management.RequestOption) error
Update mocks base method
type MockClientAPIMockRecorder ¶
type MockClientAPIMockRecorder struct {
// contains filtered or unexported fields
}
MockClientAPIMockRecorder is the mock recorder for MockClientAPI
func (*MockClientAPIMockRecorder) Create ¶
func (mr *MockClientAPIMockRecorder) Create(c interface{}, opts ...interface{}) *gomock.Call
Create indicates an expected call of Create
func (*MockClientAPIMockRecorder) Delete ¶
func (mr *MockClientAPIMockRecorder) Delete(id interface{}, opts ...interface{}) *gomock.Call
Delete indicates an expected call of Delete
func (*MockClientAPIMockRecorder) List ¶
func (mr *MockClientAPIMockRecorder) List(opts ...interface{}) *gomock.Call
List indicates an expected call of List
func (*MockClientAPIMockRecorder) Read ¶
func (mr *MockClientAPIMockRecorder) Read(id interface{}, opts ...interface{}) *gomock.Call
Read indicates an expected call of Read
func (*MockClientAPIMockRecorder) RotateSecret ¶
func (mr *MockClientAPIMockRecorder) RotateSecret(id interface{}, opts ...interface{}) *gomock.Call
RotateSecret indicates an expected call of RotateSecret
func (*MockClientAPIMockRecorder) Update ¶
func (mr *MockClientAPIMockRecorder) Update(id, c interface{}, opts ...interface{}) *gomock.Call
Update indicates an expected call of Update
type MockLogAPI ¶
type MockLogAPI struct {
// contains filtered or unexported fields
}
MockLogAPI is a mock of LogAPI interface
func NewMockLogAPI ¶
func NewMockLogAPI(ctrl *gomock.Controller) *MockLogAPI
NewMockLogAPI creates a new mock instance
func (*MockLogAPI) EXPECT ¶
func (m *MockLogAPI) EXPECT() *MockLogAPIMockRecorder
EXPECT returns an object that allows the caller to indicate expected use
func (*MockLogAPI) List ¶
func (m *MockLogAPI) List(opts ...management.RequestOption) ([]*management.Log, error)
List mocks base method
func (*MockLogAPI) Read ¶
func (m *MockLogAPI) Read(id string, opts ...management.RequestOption) (*management.Log, error)
Read mocks base method
func (*MockLogAPI) Search ¶
func (m *MockLogAPI) Search(opts ...management.RequestOption) ([]*management.Log, error)
Search mocks base method
type MockLogAPIMockRecorder ¶
type MockLogAPIMockRecorder struct {
// contains filtered or unexported fields
}
MockLogAPIMockRecorder is the mock recorder for MockLogAPI
func (*MockLogAPIMockRecorder) List ¶
func (mr *MockLogAPIMockRecorder) List(opts ...interface{}) *gomock.Call
List indicates an expected call of List
func (*MockLogAPIMockRecorder) Read ¶
func (mr *MockLogAPIMockRecorder) Read(id interface{}, opts ...interface{}) *gomock.Call
Read indicates an expected call of Read
func (*MockLogAPIMockRecorder) Search ¶
func (mr *MockLogAPIMockRecorder) Search(opts ...interface{}) *gomock.Call
Search indicates an expected call of Search
type MockResourceServerAPI ¶
type MockResourceServerAPI struct {
// contains filtered or unexported fields
}
MockResourceServerAPI is a mock of ResourceServerAPI interface
func NewMockResourceServerAPI ¶
func NewMockResourceServerAPI(ctrl *gomock.Controller) *MockResourceServerAPI
NewMockResourceServerAPI creates a new mock instance
func (*MockResourceServerAPI) Create ¶
func (m *MockResourceServerAPI) Create(rs *management.ResourceServer, opts ...management.RequestOption) error
Create mocks base method
func (*MockResourceServerAPI) Delete ¶
func (m *MockResourceServerAPI) Delete(id string, opts ...management.RequestOption) error
Delete mocks base method
func (*MockResourceServerAPI) EXPECT ¶
func (m *MockResourceServerAPI) EXPECT() *MockResourceServerAPIMockRecorder
EXPECT returns an object that allows the caller to indicate expected use
func (*MockResourceServerAPI) List ¶
func (m *MockResourceServerAPI) List(opts ...management.RequestOption) (*management.ResourceServerList, error)
List mocks base method
func (*MockResourceServerAPI) Read ¶
func (m *MockResourceServerAPI) Read(id string, opts ...management.RequestOption) (*management.ResourceServer, error)
Read mocks base method
func (*MockResourceServerAPI) Stream ¶
func (m *MockResourceServerAPI) Stream(fn func(*management.ResourceServer), opts ...management.RequestOption) error
Stream mocks base method
func (*MockResourceServerAPI) Update ¶
func (m *MockResourceServerAPI) Update(id string, rs *management.ResourceServer, opts ...management.RequestOption) error
Update mocks base method
type MockResourceServerAPIMockRecorder ¶
type MockResourceServerAPIMockRecorder struct {
// contains filtered or unexported fields
}
MockResourceServerAPIMockRecorder is the mock recorder for MockResourceServerAPI
func (*MockResourceServerAPIMockRecorder) Create ¶
func (mr *MockResourceServerAPIMockRecorder) Create(rs interface{}, opts ...interface{}) *gomock.Call
Create indicates an expected call of Create
func (*MockResourceServerAPIMockRecorder) Delete ¶
func (mr *MockResourceServerAPIMockRecorder) Delete(id interface{}, opts ...interface{}) *gomock.Call
Delete indicates an expected call of Delete
func (*MockResourceServerAPIMockRecorder) List ¶
func (mr *MockResourceServerAPIMockRecorder) List(opts ...interface{}) *gomock.Call
List indicates an expected call of List
func (*MockResourceServerAPIMockRecorder) Read ¶
func (mr *MockResourceServerAPIMockRecorder) Read(id interface{}, opts ...interface{}) *gomock.Call
Read indicates an expected call of Read
func (*MockResourceServerAPIMockRecorder) Stream ¶
func (mr *MockResourceServerAPIMockRecorder) Stream(fn interface{}, opts ...interface{}) *gomock.Call
Stream indicates an expected call of Stream
func (*MockResourceServerAPIMockRecorder) Update ¶
func (mr *MockResourceServerAPIMockRecorder) Update(id, rs interface{}, opts ...interface{}) *gomock.Call
Update indicates an expected call of Update
type MockRuleAPI ¶ added in v0.3.2
type MockRuleAPI struct {
// contains filtered or unexported fields
}
MockRuleAPI is a mock of RuleAPI interface
func NewMockRuleAPI ¶ added in v0.3.2
func NewMockRuleAPI(ctrl *gomock.Controller) *MockRuleAPI
NewMockRuleAPI creates a new mock instance
func (*MockRuleAPI) Create ¶ added in v0.3.2
func (m *MockRuleAPI) Create(r *management.Rule, opts ...management.RequestOption) error
Create mocks base method
func (*MockRuleAPI) Delete ¶ added in v0.3.2
func (m *MockRuleAPI) Delete(id string, opts ...management.RequestOption) error
Delete mocks base method
func (*MockRuleAPI) EXPECT ¶ added in v0.3.2
func (m *MockRuleAPI) EXPECT() *MockRuleAPIMockRecorder
EXPECT returns an object that allows the caller to indicate expected use
func (*MockRuleAPI) List ¶ added in v0.3.2
func (m *MockRuleAPI) List(opts ...management.RequestOption) (*management.RuleList, error)
List mocks base method
func (*MockRuleAPI) Read ¶ added in v0.3.2
func (m *MockRuleAPI) Read(id string, opts ...management.RequestOption) (*management.Rule, error)
Read mocks base method
func (*MockRuleAPI) Update ¶ added in v0.3.2
func (m *MockRuleAPI) Update(id string, r *management.Rule, opts ...management.RequestOption) error
Update mocks base method
type MockRuleAPIMockRecorder ¶ added in v0.3.2
type MockRuleAPIMockRecorder struct {
// contains filtered or unexported fields
}
MockRuleAPIMockRecorder is the mock recorder for MockRuleAPI
func (*MockRuleAPIMockRecorder) Create ¶ added in v0.3.2
func (mr *MockRuleAPIMockRecorder) Create(r interface{}, opts ...interface{}) *gomock.Call
Create indicates an expected call of Create
func (*MockRuleAPIMockRecorder) Delete ¶ added in v0.3.2
func (mr *MockRuleAPIMockRecorder) Delete(id interface{}, opts ...interface{}) *gomock.Call
Delete indicates an expected call of Delete
func (*MockRuleAPIMockRecorder) List ¶ added in v0.3.2
func (mr *MockRuleAPIMockRecorder) List(opts ...interface{}) *gomock.Call
List indicates an expected call of List
func (*MockRuleAPIMockRecorder) Read ¶ added in v0.3.2
func (mr *MockRuleAPIMockRecorder) Read(id interface{}, opts ...interface{}) *gomock.Call
Read indicates an expected call of Read
func (*MockRuleAPIMockRecorder) Update ¶ added in v0.3.2
func (mr *MockRuleAPIMockRecorder) Update(id, r interface{}, opts ...interface{}) *gomock.Call
Update indicates an expected call of Update
type OrganizationAPI ¶ added in v0.10.0
type OrganizationAPI interface {
// Create an Organization
//
// See: https://auth0.com/docs/api/management/v2/#!/Organizations/post_organizations
Create(o *management.Organization, opts ...management.RequestOption) error
// Get a specific organization
//
// See: https://auth0.com/docs/api/management/v2/#!/Organizations/get_organizations_by_id
Read(id string, opts ...management.RequestOption) (*management.Organization, error)
// Modify an organization
//
// See: https://auth0.com/docs/api/management/v2/#!/Organizations/patch_organizations_by_id
Update(o *management.Organization, opts ...management.RequestOption) error
// Delete a specific organization
//
// See: https://auth0.com/docs/api/management/v2/#!/Organizations/delete_organizations_by_id
Delete(id string, opts ...management.RequestOption) error
// List available organizations
//
// See: https://auth0.com/docs/api/management/v2/#!/Organizations/get_organizations
List(opts ...management.RequestOption) (c *management.OrganizationList, err error)
}
type Quickstart ¶ added in v0.5.0
type ResourceServerAPI ¶
type ResourceServerAPI interface {
// Create a resource server.
Create(rs *management.ResourceServer, opts ...management.RequestOption) (err error)
// Read retrieves a resource server by its id or audience.
Read(id string, opts ...management.RequestOption) (rs *management.ResourceServer, err error)
// Update a resource server.
Update(id string, rs *management.ResourceServer, opts ...management.RequestOption) (err error)
// Delete a resource server.
Delete(id string, opts ...management.RequestOption) (err error)
// List all resource server.
List(opts ...management.RequestOption) (rl *management.ResourceServerList, err error)
// Stream is a helper method which handles pagination
Stream(fn func(s *management.ResourceServer), opts ...management.RequestOption) error
}
type RoleAPI ¶ added in v0.7.0
type RoleAPI interface {
// Create a new role.
Create(r *management.Role, opts ...management.RequestOption) (err error)
// Retrieve a role.
Read(id string, opts ...management.RequestOption) (r *management.Role, err error)
// List all roles that can be assigned to users or groups.
List(opts ...management.RequestOption) (r *management.RoleList, err error)
// Update a role.
Update(id string, r *management.Role, opts ...management.RequestOption) (err error)
// Delete a role.
Delete(id string, opts ...management.RequestOption) (err error)
// AssociatePermissions associates permissions to a role.
//
// See: https://auth0.com/docs/api/management/v2#!/Roles/post_role_permission_assignment
AssociatePermissions(id string, permissions []*management.Permission, opts ...management.RequestOption) error
// Permissions retrieves all permissions granted by a role.
//
// See: https://auth0.com/docs/api/management/v2#!/Roles/get_role_permission
Permissions(id string, opts ...management.RequestOption) (p *management.PermissionList, err error)
// RemovePermissions removes permissions associated to a role.
//
// See: https://auth0.com/docs/api/management/v2#!/Roles/delete_role_permission_assignment
RemovePermissions(id string, permissions []*management.Permission, opts ...management.RequestOption) error
}
type RuleAPI ¶ added in v0.3.0
type RuleAPI interface {
// Create a new rule.
//
// Note: Changing a rule's stage of execution from the default `login_success`
// can change the rule's function signature to have user omitted.
Create(r *management.Rule, opts ...management.RequestOption) error
// Retrieve rule details. Accepts a list of fields to include or exclude in the result.
Read(id string, opts ...management.RequestOption) (r *management.Rule, err error)
// Update an existing rule.
Update(id string, r *management.Rule, opts ...management.RequestOption) error
// Delete a rule.
Delete(id string, opts ...management.RequestOption) error
// List all rules.
List(opts ...management.RequestOption) (r *management.RuleList, err error)
}
type TenantAPI ¶ added in v0.6.0
type TenantAPI interface {
Read(opts ...management.RequestOption) (t *management.Tenant, err error)
}
type UserAPI ¶ added in v0.5.1
type UserAPI interface {
// Retrieves a list of blocked IP addresses of a particular user.
Blocks(id string, opts ...management.RequestOption) ([]*management.UserBlock, error)
// Unblock a user that was blocked due to an excessive amount of incorrectly
// provided credentials.
Unblock(id string, opts ...management.RequestOption) error
// Create a new user.
Create(u *management.User, opts ...management.RequestOption) (err error)
// Read user details for a given user.
Read(id string, opts ...management.RequestOption) (u *management.User, err error)
// Update user.
Update(id string, u *management.User, opts ...management.RequestOption) (err error)
// Delete a user.
Delete(id string, opts ...management.RequestOption) (err error)
// List all users.
List(opts ...management.RequestOption) (ul *management.UserList, err error)
// Search for users
Search(opts ...management.RequestOption) (us *management.UserList, err error)
}