scim_api

Documentation

Index

• func DeleteGroup(ctx context.Context, service *zscaler.ScimService, groupID string) (*http.Response, error)
• func DeleteUser(ctx context.Context, service *zscaler.ScimService, userID string) (*http.Response, error)
• func PatchGroup(ctx context.Context, service *zscaler.ScimService, groupID string, ...) (*http.Response, error)
• func PatchUser(ctx context.Context, service *zscaler.ScimService, userID string, ...) (*http.Response, error)
• func UpdateGroup(ctx context.Context, service *zscaler.ScimService, groupID string, ...) (*http.Response, error)
• func UpdateUser(ctx context.Context, service *zscaler.ScimService, userID string, ...) (*http.Response, error)
• type EnterpriseUser
• type Group
• type ScimGroup
  • func CreateGroup(ctx context.Context, service *zscaler.ScimService, scimGroup *ScimGroup) (*ScimGroup, *http.Response, error)
  • func GetAllGroups(ctx context.Context, service *zscaler.ScimService, count ...int) ([]ScimGroup, *http.Response, error)
  • func GetGroup(ctx context.Context, service *zscaler.ScimService, groupID string) (*ScimGroup, *http.Response, error)
  • func GetGroupByName(ctx context.Context, service *zscaler.ScimService, groupName string) (*ScimGroup, *http.Response, error)
• type ScimUser
  • func CreateUser(ctx context.Context, service *zscaler.ScimService, scimUser *ScimUser) (*ScimUser, *http.Response, error)
  • func GetAllUsers(ctx context.Context, service *zscaler.ScimService, count ...int) ([]ScimUser, *http.Response, error)
  • func GetUser(ctx context.Context, service *zscaler.ScimService, userID string) (*ScimUser, *http.Response, error)
  • func GetUserByName(ctx context.Context, service *zscaler.ScimService, userName string) (*ScimUser, *http.Response, error)
• type User
• type UserGroup
• type UserName

Functions

func DeleteGroup

func DeleteGroup(ctx context.Context, service *zscaler.ScimService, groupID string) (*http.Response, error)

func DeleteUser

func DeleteUser(ctx context.Context, service *zscaler.ScimService, userID string) (*http.Response, error)

func PatchGroup

func PatchGroup(ctx context.Context, service *zscaler.ScimService, groupID string, scimGroup *ScimGroup) (*http.Response, error)

func PatchUser

func PatchUser(ctx context.Context, service *zscaler.ScimService, userID string, ScimUser *ScimUser) (*http.Response, error)

func UpdateGroup

func UpdateGroup(ctx context.Context, service *zscaler.ScimService, groupID string, scimGroup *ScimGroup) (*http.Response, error)

func UpdateUser

func UpdateUser(ctx context.Context, service *zscaler.ScimService, userID string, ScimUser *ScimUser) (*http.Response, error)

Types

type EnterpriseUser

type EnterpriseUser struct {
	Department string `json:"department"`
}

EnterpriseUser represents the enterprise-specific extension for user details

type Group

type Group struct {
	Schemas     []string    `json:"schemas"`
	ID          string      `json:"id"`
	ExternalID  *string     `json:"externalId,omitempty"`
	DisplayName string      `json:"displayName"`
	Meta        common.Meta `json:"meta"`
}

Group represents an individual group within the Resources array in the response

type ScimGroup

type ScimGroup struct {
	Schemas     []string    `json:"schemas"`
	ID          string      `json:"id"`
	ExternalID  *string     `json:"externalId,omitempty"`
	DisplayName string      `json:"displayName"`
	Meta        common.Meta `json:"meta"`
}

ScimGroups represents the response from the /groups endpoint

func CreateGroup

func CreateGroup(ctx context.Context, service *zscaler.ScimService, scimGroup *ScimGroup) (*ScimGroup, *http.Response, error)

func GetAllGroups

func GetAllGroups(ctx context.Context, service *zscaler.ScimService, count ...int) ([]ScimGroup, *http.Response, error)

func GetGroup

func GetGroup(ctx context.Context, service *zscaler.ScimService, groupID string) (*ScimGroup, *http.Response, error)

GetGroup retrieves a specific SCIM group by groupID

func GetGroupByName

func GetGroupByName(ctx context.Context, service *zscaler.ScimService, groupName string) (*ScimGroup, *http.Response, error)

type ScimUser

type ScimUser struct {
	Schemas     []string    `json:"schemas"`
	ID          string      `json:"id"`
	ExternalID  *string     `json:"externalId,omitempty"`
	DisplayName string      `json:"displayName"`
	Meta        common.Meta `json:"meta"`
}

ScimUsers represents the response from the /users endpoint

func CreateUser

func CreateUser(ctx context.Context, service *zscaler.ScimService, scimUser *ScimUser) (*ScimUser, *http.Response, error)

func GetAllUsers

func GetAllUsers(ctx context.Context, service *zscaler.ScimService, count ...int) ([]ScimUser, *http.Response, error)

func GetUser

func GetUser(ctx context.Context, service *zscaler.ScimService, userID string) (*ScimUser, *http.Response, error)

func GetUserByName

func GetUserByName(ctx context.Context, service *zscaler.ScimService, userName string) (*ScimUser, *http.Response, error)

type User

type User struct {
	Schemas     []string       `json:"schemas"`
	ID          string         `json:"id"`
	ExternalID  string         `json:"externalId"`
	Active      bool           `json:"active"`
	UserName    string         `json:"userName"`
	DisplayName string         `json:"displayName,omitempty"`
	Name        UserName       `json:"name"`
	Groups      []UserGroup    `json:"groups,omitempty"`
	Enterprise  EnterpriseUser `json:"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,omitempty"`
	Meta        common.Meta    `json:"meta"`
}

User represents an individual user within the Resources array

type UserGroup

type UserGroup struct {
	Display string `json:"display"`
	Value   string `json:"value"`
	Ref     string `json:"$ref"`
}

UserGroup represents a group that the user belongs to

type UserName

type UserName struct {
	FamilyName string `json:"familyName"`
	GivenName  string `json:"givenName"`
}

UserName represents the user's name information