Documentation ¶
Overview ¶
The role package contains methods for making calls to LoginRadius Role Management API endpoints The Roles APIs are used to manage the creation and assignment of user roles for a customer account.
Index ¶
- type Loginradius
- func (lr Loginradius) DeleteAccountRole(role string) (*httprutils.Response, error)
- func (lr Loginradius) DeleteAdditionalPermissionFromContext(uid, rolecontextname string, body interface{}) (*httprutils.Response, error)
- func (lr Loginradius) DeleteContextFromRole(uid, rolecontextname string) (*httprutils.Response, error)
- func (lr Loginradius) DeleteRoleFromContext(uid, rolecontextname string, body interface{}) (*httprutils.Response, error)
- func (lr Loginradius) DeleteRolesAccountRemovePermissions(roleName string, body interface{}) (*httprutils.Response, error)
- func (lr Loginradius) DeleteRolesAssignedToUser(uid string, body interface{}) (*httprutils.Response, error)
- func (lr Loginradius) GetContextRolesPermissions(uid string) (*httprutils.Response, error)
- func (lr Loginradius) GetRolesByUID(uid string) (*httprutils.Response, error)
- func (lr Loginradius) GetRolesList() (*httprutils.Response, error)
- func (lr Loginradius) PostRolesCreate(body interface{}) (*httprutils.Response, error)
- func (lr Loginradius) PutAccountAddPermissionsToRole(role string, body interface{}) (*httprutils.Response, error)
- func (lr Loginradius) PutRolesAssignToUser(uid string, body interface{}) (*httprutils.Response, error)
- func (lr Loginradius) PutRolesUpsertContext(uid string, body interface{}) (*httprutils.Response, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Loginradius ¶
type Loginradius struct {
Client *lr.Loginradius
}
Embed Loginradius struct
func (Loginradius) DeleteAccountRole ¶
func (lr Loginradius) DeleteAccountRole(role string) (*httprutils.Response, error)
Required template parameter: role - string representing the rolename of the role to be deleted
func (Loginradius) DeleteAdditionalPermissionFromContext ¶
func (lr Loginradius) DeleteAdditionalPermissionFromContext(uid, rolecontextname string, body interface{}) (*httprutils.Response, error)
Required post parameters: additionalpermissions - array of strings representing names of additional permissions
func (Loginradius) DeleteContextFromRole ¶
func (lr Loginradius) DeleteContextFromRole(uid, rolecontextname string) (*httprutils.Response, error)
Required template parameter: uid - string preresenting user's uid; rolecontextname - string representing the name of the role context to be deleted
func (Loginradius) DeleteRoleFromContext ¶
func (lr Loginradius) DeleteRoleFromContext(uid, rolecontextname string, body interface{}) (*httprutils.Response, error)
Required body parameters: roles - array of strings representing the role name(s) to be deleted
func (Loginradius) DeleteRolesAccountRemovePermissions ¶
func (lr Loginradius) DeleteRolesAccountRemovePermissions(roleName string, body interface{}) (*httprutils.Response, error)
Pass data in struct lrbody.PermissionList as body to help ensure parameters satisfy API requirements; alternatively, []byte could also be passed as body
func (Loginradius) DeleteRolesAssignedToUser ¶
func (lr Loginradius) DeleteRolesAssignedToUser(uid string, body interface{}) (*httprutils.Response, error)
Sample body parameter: map[string][]string{"roles":[]string{"role1", "role2"}} or []byte{`{"roles":["role1", "role2"]}`}
func (Loginradius) GetContextRolesPermissions ¶
func (lr Loginradius) GetContextRolesPermissions(uid string) (*httprutils.Response, error)
Required template parameter: uid - string representing uid of the user
func (Loginradius) GetRolesByUID ¶
func (lr Loginradius) GetRolesByUID(uid string) (*httprutils.Response, error)
Required template parameter: uid - string representing user's uid
func (Loginradius) GetRolesList ¶
func (lr Loginradius) GetRolesList() (*httprutils.Response, error)
Documentation: https://www.loginradius.com/docs/api/v2/customer-identity-api/roles-management/roles-list
func (Loginradius) PostRolesCreate ¶
func (lr Loginradius) PostRolesCreate(body interface{}) (*httprutils.Response, error)
Pass data in struct lrbody.Roles as body to help ensure parameters satisfy API requirements; alternatively, []byte could also be passed as body
func (Loginradius) PutAccountAddPermissionsToRole ¶
func (lr Loginradius) PutAccountAddPermissionsToRole(role string, body interface{}) (*httprutils.Response, error)
Pass data in struct lrbody.PermissionList as body to help ensure parameters satisfy API requirements; alternatively, []byte could also be passed as body
func (Loginradius) PutRolesAssignToUser ¶
func (lr Loginradius) PutRolesAssignToUser(uid string, body interface{}) (*httprutils.Response, error)
Pass data in struct lrbody.RoleList as body to help ensure parameters satisfy API requirements; alternatively, []byte could also be passed as body
func (Loginradius) PutRolesUpsertContext ¶
func (lr Loginradius) PutRolesUpsertContext(uid string, body interface{}) (*httprutils.Response, error)
Rolecontext object must contain: context - string; roles: array of strings representing role names; additionalpermissions: array of strings representing additional permissions; expiration: date of expiration of role context, format mm/dd/yyyy h:m:s