Documentation
¶
Overview ¶
Access Management within StackGuardian allows administrators to control user access levels within the organization.
Access Management provides options to assign roles to users or groups, define custom roles, and manage login methods.
For more details, visit our [Documentation](https://docs.stackguardian.io/docs/organisation_settings/access_management).
Index ¶
- type Client
- func (c *Client) CreateRole(ctx context.Context, org string, request *sgsdkgo.Role, ...) (*sgsdkgo.RoleCreateUpdateResponse, error)
- func (c *Client) CreateUser(ctx context.Context, org string, request *sgsdkgo.AddUserToOrganization, ...) (*sgsdkgo.AddUserToOrganizationResponse, error)
- func (c *Client) DeleteRole(ctx context.Context, org string, role string, opts ...option.RequestOption) error
- func (c *Client) DeleteUser(ctx context.Context, org string, ...) (*sgsdkgo.RemoveUserFromOrganizationResponse, error)
- func (c *Client) ListAllRoles(ctx context.Context, org string, opts ...option.RequestOption) error
- func (c *Client) ReadRole(ctx context.Context, org string, role string, opts ...option.RequestOption) (*sgsdkgo.RoleGetResponse, error)
- func (c *Client) ReadUser(ctx context.Context, org string, ...) (*sgsdkgo.RemoveUserFromOrganizationResponse, error)
- func (c *Client) UpdateRole(ctx context.Context, org string, role string, request *sgsdkgo.PatchedRole, ...) (*sgsdkgo.RoleCreateUpdateResponse, error)
- func (c *Client) UpdateUser(ctx context.Context, org string, request *sgsdkgo.AddUserToOrganization, ...) (*sgsdkgo.AddUserToOrganizationResponse, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func NewClient ¶
func NewClient(opts ...option.RequestOption) *Client
func (*Client) CreateRole ¶
func (c *Client) CreateRole( ctx context.Context, org string, request *sgsdkgo.Role, opts ...option.RequestOption, ) (*sgsdkgo.RoleCreateUpdateResponse, error)
Create a new Role inside an Organization.
func (*Client) CreateUser ¶
func (c *Client) CreateUser( ctx context.Context, org string, request *sgsdkgo.AddUserToOrganization, opts ...option.RequestOption, ) (*sgsdkgo.AddUserToOrganizationResponse, error)
Invite users or SSO groups to an Organization.
func (*Client) DeleteRole ¶
func (c *Client) DeleteRole( ctx context.Context, org string, role string, opts ...option.RequestOption, ) error
Delete the specified Role from the Organization.
func (*Client) DeleteUser ¶
func (c *Client) DeleteUser( ctx context.Context, org string, request *sgsdkgo.GetorRemoveUserFromOrganization, opts ...option.RequestOption, ) (*sgsdkgo.RemoveUserFromOrganizationResponse, error)
Delete an existing user or SSO group from an Organization.
func (*Client) ListAllRoles ¶
func (c *Client) ListAllRoles( ctx context.Context, org string, opts ...option.RequestOption, ) error
List all the Roles inside an Organization.
func (*Client) ReadRole ¶
func (c *Client) ReadRole( ctx context.Context, org string, role string, opts ...option.RequestOption, ) (*sgsdkgo.RoleGetResponse, error)
Retrieve the details of an existing Role.
func (*Client) ReadUser ¶
func (c *Client) ReadUser( ctx context.Context, org string, request *sgsdkgo.GetorRemoveUserFromOrganization, opts ...option.RequestOption, ) (*sgsdkgo.RemoveUserFromOrganizationResponse, error)
Retrieve the details of an user or SSO group within an Organization.
func (*Client) UpdateRole ¶
func (c *Client) UpdateRole( ctx context.Context, org string, role string, request *sgsdkgo.PatchedRole, opts ...option.RequestOption, ) (*sgsdkgo.RoleCreateUpdateResponse, error)
Update an existing Role.
func (*Client) UpdateUser ¶
func (c *Client) UpdateUser( ctx context.Context, org string, request *sgsdkgo.AddUserToOrganization, opts ...option.RequestOption, ) (*sgsdkgo.AddUserToOrganizationResponse, error)
Update an existing user or SSO group within an Organization.
Source Files
Click to show internal directories.
Click to hide internal directories.