Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

iam

package

Go to main page

Versions in this module

v8

v8.4.0

Aug 22, 2024

Changes in this version

+ var ErrGetProperty = errors.New("get property")

+ var ErrListProperties = errors.New("list properties")

+ var ErrMapPropertyIDToName = errors.New("map property by id")

+ var ErrMapPropertyNameToID = errors.New("map property by name")

+ var ErrMoveProperty = errors.New("move property")

+ var ErrNoProperty = errors.New("no such property")

+ type GetPropertyRequest struct

+ GroupID int64

+ PropertyID int64

+ func (r GetPropertyRequest) Validate() error

+ type GetPropertyResponse struct

+ ARLConfigFile string

+ CreatedBy string

+ CreatedDate time.Time

+ GroupID int64

+ GroupName string

+ ModifiedBy string

+ ModifiedDate time.Time

+ PropertyID int64

+ PropertyName string

+ type ListPropertiesRequest struct

+ Actions bool

+ GroupID int64

+ type ListPropertiesResponse []Property

+ type MapPropertyIDToNameRequest struct

+ GroupID int64

+ PropertyID int64

+ func (r MapPropertyIDToNameRequest) Validate() error

+ type MapPropertyNameToIDRequest string

type Mock

+ func (m *Mock) GetProperty(ctx context.Context, request GetPropertyRequest) (*GetPropertyResponse, error)

+ func (m *Mock) ListProperties(ctx context.Context, request ListPropertiesRequest) (*ListPropertiesResponse, error)

+ func (m *Mock) MapPropertyIDToName(ctx context.Context, request MapPropertyIDToNameRequest) (*string, error)

+ func (m *Mock) MapPropertyNameToID(ctx context.Context, request MapPropertyNameToIDRequest) (*int64, error)

+ func (m *Mock) MoveProperty(ctx context.Context, request MovePropertyRequest) error

+ type MovePropertyReqBody struct

+ DestinationGroupID int64

+ SourceGroupID int64

+ func (r MovePropertyReqBody) Validate() error

+ type MovePropertyRequest struct

+ BodyParams MovePropertyReqBody

+ PropertyID int64

+ func (r MovePropertyRequest) Validate() error

+ type Properties interface

+ GetProperty func(context.Context, GetPropertyRequest) (*GetPropertyResponse, error)

+ ListProperties func(context.Context, ListPropertiesRequest) (*ListPropertiesResponse, error)

+ MapPropertyIDToName func(context.Context, MapPropertyIDToNameRequest) (*string, error)

+ MoveProperty func(context.Context, MovePropertyRequest) error

+ type Property struct

+ Actions PropertyActions

+ GroupID int64

+ GroupName string

+ PropertyID int64

+ PropertyName string

+ PropertyTypeDescription string

+ type PropertyActions struct

+ Move bool

v8.3.0

Jul 9, 2024

v8.2.0

May 21, 2024

v8.1.0

Apr 11, 2024

v8.0.0

Mar 19, 2024

Changes in this version

+ const GainAccessUsers

+ const LostAccessUsers

+ var ErrCreateGroup = errors.New("create group")

+ var ErrCreateRole = errors.New("create a role")

+ var ErrCreateUser = errors.New("create user")

+ var ErrDeleteRole = errors.New("delete a role")

+ var ErrGetGroup = errors.New("get group")

+ var ErrGetRole = errors.New("get a role")

+ var ErrGetUser = errors.New("get user")

+ var ErrInputValidation = errors.New("input validation error")

+ var ErrListAffectedUsers = errors.New("list affected users")

+ var ErrListBlockedProperties = errors.New("list blocked properties")

+ var ErrListGrantableRoles = errors.New("list grantable roles")

+ var ErrListGroups = errors.New("list groups")

+ var ErrListProducts = errors.New("list products")

+ var ErrListRoles = errors.New("list roles")

+ var ErrListStates = errors.New("list states")

+ var ErrListTimeoutPolicies = errors.New("list timeout policies")

+ var ErrListUsers = errors.New("list users")

+ var ErrLockUser = errors.New("lock user")

+ var ErrMoveGroup = errors.New("move group")

+ var ErrRemoveGroup = errors.New("remove group")

+ var ErrRemoveUser = errors.New("remove user")

+ var ErrResetUserPassword = errors.New("reset user password")

+ var ErrSetUserPassword = errors.New("set user password")

+ var ErrStructValidation = errors.New("struct validation")

+ var ErrSupportedContactTypes = errors.New("supported contact types")

+ var ErrSupportedCountries = errors.New("supported countries")

+ var ErrSupportedLanguages = errors.New("supported languages")

+ var ErrSupportedTimezones = errors.New("supported timezones")

+ var ErrUnlockUser = errors.New("unlock user")

+ var ErrUpdateBlockedProperties = errors.New("update blocked properties")

+ var ErrUpdateGroupName = errors.New("update group name")

+ var ErrUpdateRole = errors.New("update a role")

+ var ErrUpdateTFA = errors.New("update user's two-factor authentication")

+ var ErrUpdateUserAuthGrants = errors.New("update user auth grants")

+ var ErrUpdateUserInfo = errors.New("update user info")

+ var ErrUpdateUserNotifications = errors.New("update user notifications")

+ type AuthGrant struct

+ GroupID int64

+ GroupName string

+ IsBlocked bool

+ RoleDescription string

+ RoleID *int

+ RoleName string

+ Subgroups []AuthGrant

+ func (r AuthGrant) Validate() error

+ type AuthGrantRequest struct

+ GroupID int64

+ IsBlocked bool

+ RoleID *int

+ Subgroups []AuthGrantRequest

+ type BlockedProperties interface

+ ListBlockedProperties func(context.Context, ListBlockedPropertiesRequest) ([]int64, error)

+ UpdateBlockedProperties func(context.Context, UpdateBlockedPropertiesRequest) ([]int64, error)

+ type ClientFunc func(sess session.Session, opts ...Option) IAM

+ type CreateRoleRequest RoleRequest

+ func (r CreateRoleRequest) Validate() error

+ type CreateUserRequest struct

+ AuthGrants []AuthGrantRequest

+ Notifications UserNotifications

+ SendEmail bool

+ func (r CreateUserRequest) Validate() error

+ type DeleteRoleRequest struct

+ ID int64

+ func (r DeleteRoleRequest) Validate() error

+ type Error struct

+ BehaviorName string

+ Detail string

+ ErrorLocation string

+ Errors json.RawMessage

+ HTTPStatus int

+ Instance string

+ StatusCode int

+ Title string

+ Type string

+ Warnings json.RawMessage

+ func (e *Error) Error() string

+ func (e *Error) Is(target error) bool

+ type GetGroupRequest struct

+ Actions bool

+ GroupID int64

+ func (r GetGroupRequest) Validate() error

+ type GetRoleRequest struct

+ Actions bool

+ GrantedRoles bool

+ ID int64

+ Users bool

+ func (r GetRoleRequest) Validate() error

+ type GetUserRequest struct

+ Actions bool

+ AuthGrants bool

+ IdentityID string

+ Notifications bool

+ func (r GetUserRequest) Validate() error

+ type GrantedRoleID struct

+ ID int64

+ type Group struct

+ Actions *GroupActions

+ CreatedBy string

+ CreatedDate string

+ GroupID int64

+ GroupName string

+ ModifiedBy string

+ ModifiedDate string

+ ParentGroupID int64

+ SubGroups []Group

+ type GroupActions struct

+ Delete bool

+ Edit bool

+ type GroupRequest struct

+ GroupID int64

+ GroupName string

+ func (r GroupRequest) Validate() error

+ type GroupUser struct

+ AccountID string

+ Email string

+ FirstName string

+ IdentityID string

+ LastLoginDate string

+ LastName string

+ UserName string

+ type Groups interface

+ CreateGroup func(context.Context, GroupRequest) (*Group, error)

+ GetGroup func(context.Context, GetGroupRequest) (*Group, error)

+ ListAffectedUsers func(context.Context, ListAffectedUsersRequest) ([]GroupUser, error)

+ ListGroups func(context.Context, ListGroupsRequest) ([]Group, error)

+ MoveGroup func(context.Context, MoveGroupRequest) error

+ RemoveGroup func(context.Context, RemoveGroupRequest) error

+ UpdateGroupName func(context.Context, GroupRequest) (*Group, error)

+ type IAM interface

+ func Client(sess session.Session, opts ...Option) IAM

+ type ListAffectedUsersRequest struct

+ DestinationGroupID int64

+ SourceGroupID int64

+ UserType string

+ func (r ListAffectedUsersRequest) Validate() error

+ type ListBlockedPropertiesRequest struct

+ GroupID int64

+ IdentityID string

+ func (r ListBlockedPropertiesRequest) Validate() error

+ type ListGroupsRequest struct

+ Actions bool

+ type ListRolesRequest struct

+ Actions bool

+ GroupID *int64

+ IgnoreContext bool

+ Users bool

+ type ListStatesRequest struct

+ Country string

+ func (r ListStatesRequest) Validate() error

+ type ListUsersRequest struct

+ Actions bool

+ AuthGrants bool

+ GroupID *int64

+ type LockUserRequest struct

+ IdentityID string

+ func (r LockUserRequest) Validate() error

+ type Mock struct

+ func (m *Mock) CreateGroup(ctx context.Context, request GroupRequest) (*Group, error)

+ func (m *Mock) CreateRole(ctx context.Context, request CreateRoleRequest) (*Role, error)

+ func (m *Mock) CreateUser(ctx context.Context, request CreateUserRequest) (*User, error)

+ func (m *Mock) DeleteRole(ctx context.Context, request DeleteRoleRequest) error

+ func (m *Mock) GetGroup(ctx context.Context, request GetGroupRequest) (*Group, error)

+ func (m *Mock) GetRole(ctx context.Context, request GetRoleRequest) (*Role, error)

+ func (m *Mock) GetUser(ctx context.Context, request GetUserRequest) (*User, error)

+ func (m *Mock) ListAffectedUsers(ctx context.Context, request ListAffectedUsersRequest) ([]GroupUser, error)

+ func (m *Mock) ListBlockedProperties(ctx context.Context, request ListBlockedPropertiesRequest) ([]int64, error)

+ func (m *Mock) ListGrantableRoles(ctx context.Context) ([]RoleGrantedRole, error)

+ func (m *Mock) ListGroups(ctx context.Context, request ListGroupsRequest) ([]Group, error)

+ func (m *Mock) ListProducts(ctx context.Context) ([]string, error)

+ func (m *Mock) ListRoles(ctx context.Context, request ListRolesRequest) ([]Role, error)

+ func (m *Mock) ListStates(ctx context.Context, request ListStatesRequest) ([]string, error)

+ func (m *Mock) ListTimeoutPolicies(ctx context.Context) ([]TimeoutPolicy, error)

+ func (m *Mock) ListUsers(ctx context.Context, request ListUsersRequest) ([]UserListItem, error)

+ func (m *Mock) LockUser(ctx context.Context, request LockUserRequest) error

+ func (m *Mock) MoveGroup(ctx context.Context, request MoveGroupRequest) error

+ func (m *Mock) RemoveGroup(ctx context.Context, request RemoveGroupRequest) error

+ func (m *Mock) RemoveUser(ctx context.Context, request RemoveUserRequest) error

+ func (m *Mock) ResetUserPassword(ctx context.Context, request ResetUserPasswordRequest) (*ResetUserPasswordResponse, error)

+ func (m *Mock) SetUserPassword(ctx context.Context, request SetUserPasswordRequest) error

+ func (m *Mock) SupportedContactTypes(ctx context.Context) ([]string, error)

+ func (m *Mock) SupportedCountries(ctx context.Context) ([]string, error)

+ func (m *Mock) SupportedLanguages(ctx context.Context) ([]string, error)

+ func (m *Mock) SupportedTimezones(ctx context.Context) ([]Timezone, error)

+ func (m *Mock) UnlockUser(ctx context.Context, request UnlockUserRequest) error

+ func (m *Mock) UpdateBlockedProperties(ctx context.Context, request UpdateBlockedPropertiesRequest) ([]int64, error)

+ func (m *Mock) UpdateGroupName(ctx context.Context, request GroupRequest) (*Group, error)

+ func (m *Mock) UpdateRole(ctx context.Context, request UpdateRoleRequest) (*Role, error)

+ func (m *Mock) UpdateTFA(ctx context.Context, request UpdateTFARequest) error

+ func (m *Mock) UpdateUserAuthGrants(ctx context.Context, request UpdateUserAuthGrantsRequest) ([]AuthGrant, error)

+ func (m *Mock) UpdateUserInfo(ctx context.Context, request UpdateUserInfoRequest) (*UserBasicInfo, error)

+ func (m *Mock) UpdateUserNotifications(ctx context.Context, request UpdateUserNotificationsRequest) (*UserNotifications, error)

+ type MoveGroupRequest struct

+ DestinationGroupID int64

+ SourceGroupID int64

+ func (r MoveGroupRequest) Validate() error

+ type Option func(*iam)

+ type RemoveGroupRequest struct

+ GroupID int64

+ func (r RemoveGroupRequest) Validate() error

+ type RemoveUserRequest struct

+ IdentityID string

+ func (r RemoveUserRequest) Validate() error

+ type ResetUserPasswordRequest struct

+ IdentityID string

+ SendEmail bool

+ func (r ResetUserPasswordRequest) Validate() error

+ type ResetUserPasswordResponse struct

+ NewPassword string

+ type Role struct

+ Actions *RoleAction

+ CreatedBy string

+ CreatedDate string

+ GrantedRoles []RoleGrantedRole

+ ModifiedBy string

+ ModifiedDate string

+ RoleDescription string

+ RoleID int64

+ RoleName string

+ RoleType RoleType

+ Users []RoleUser

+ type RoleAction struct

+ Delete bool

+ Edit bool

+ type RoleGrantedRole struct

+ Description string

+ RoleID int64

+ RoleName string

+ type RoleRequest struct

+ Description string

+ GrantedRoles []GrantedRoleID

+ Name string

+ type RoleType string

+ var RoleTypeCustom RoleType = "custom"

+ var RoleTypeStandard RoleType = "standard"

+ type RoleUser struct

+ AccountID string

+ Email string

+ FirstName string

+ LastLoginDate string

+ LastName string

+ UIIdentityID string

+ type Roles interface

+ CreateRole func(context.Context, CreateRoleRequest) (*Role, error)

+ DeleteRole func(context.Context, DeleteRoleRequest) error

+ GetRole func(context.Context, GetRoleRequest) (*Role, error)

+ ListGrantableRoles func(context.Context) ([]RoleGrantedRole, error)

+ ListRoles func(context.Context, ListRolesRequest) ([]Role, error)

+ UpdateRole func(context.Context, UpdateRoleRequest) (*Role, error)

+ type SetUserPasswordRequest struct

+ IdentityID string

+ NewPassword string

+ func (r SetUserPasswordRequest) Validate() error

+ type Support interface

+ ListProducts func(context.Context) ([]string, error)

+ ListStates func(context.Context, ListStatesRequest) ([]string, error)

+ ListTimeoutPolicies func(context.Context) ([]TimeoutPolicy, error)

+ SupportedContactTypes func(context.Context) ([]string, error)

+ SupportedCountries func(context.Context) ([]string, error)

+ SupportedLanguages func(context.Context) ([]string, error)

+ SupportedTimezones func(context.Context) ([]Timezone, error)

+ type TFAActionType string

+ const TFAActionDisable

+ const TFAActionEnable

+ const TFAActionReset

+ type TimeoutPolicy struct

+ Name string

+ Value int64

+ type Timezone struct

+ Description string

+ Offset string

+ Posix string

+ Timezone string

+ type UnlockUserRequest struct

+ IdentityID string

+ func (r UnlockUserRequest) Validate() error

+ type UpdateBlockedPropertiesRequest struct

+ GroupID int64

+ IdentityID string

+ Properties []int64

+ func (r UpdateBlockedPropertiesRequest) Validate() error

+ type UpdateRoleRequest struct

+ ID int64

+ func (r UpdateRoleRequest) Validate() error

+ type UpdateTFARequest struct

+ Action TFAActionType

+ IdentityID string

+ func (r UpdateTFARequest) Validate() error

+ type UpdateUserAuthGrantsRequest struct

+ AuthGrants []AuthGrantRequest

+ IdentityID string

+ func (r UpdateUserAuthGrantsRequest) Validate() error

+ type UpdateUserInfoRequest struct

+ IdentityID string

+ User UserBasicInfo

+ func (r UpdateUserInfoRequest) Validate() error

+ type UpdateUserNotificationsRequest struct

+ IdentityID string

+ Notifications UserNotifications

+ func (r UpdateUserNotificationsRequest) Validate() error

+ type User struct

+ AuthGrants []AuthGrant

+ EmailUpdatePending bool

+ IdentityID string

+ IsLocked bool

+ LastLoginDate string

+ Notifications UserNotifications

+ PasswordExpiryDate string

+ TFAConfigured bool

+ type UserActions struct

+ APIClient bool

+ CanEditTFA bool

+ Delete bool

+ Edit bool

+ EditProfile bool

+ IsCloneable bool

+ ResetPassword bool

+ ThirdPartyAccess bool

+ type UserBasicInfo struct

+ Address string

+ City string

+ ContactType string

+ Country string

+ Email string

+ FirstName string

+ JobTitle string

+ LastName string

+ MobilePhone string

+ Phone string

+ PreferredLanguage string

+ SecondaryEmail string

+ SessionTimeOut *int

+ State string

+ TFAEnabled bool

+ TimeZone string

+ UserName string

+ ZipCode string

+ type UserListItem struct

+ AccountID string

+ Actions *UserActions

+ AuthGrants []AuthGrant

+ Email string

+ FirstName string

+ IdentityID string

+ IsLocked bool

+ LastLoginDate string

+ LastName string

+ TFAConfigured bool

+ TFAEnabled bool

+ UserName string

+ type UserLock interface

+ LockUser func(context.Context, LockUserRequest) error

+ UnlockUser func(context.Context, UnlockUserRequest) error

+ type UserNotificationOptions struct

+ NewUser bool

+ PasswordExpiry bool

+ Proactive []string

+ Upgrade []string

+ type UserNotifications struct

+ EnableEmail bool

+ Options UserNotificationOptions

+ type UserPassword interface

+ ResetUserPassword func(context.Context, ResetUserPasswordRequest) (*ResetUserPasswordResponse, error)

+ SetUserPassword func(context.Context, SetUserPasswordRequest) error

+ type Users interface

+ CreateUser func(context.Context, CreateUserRequest) (*User, error)

+ GetUser func(context.Context, GetUserRequest) (*User, error)

+ ListUsers func(context.Context, ListUsersRequest) ([]UserListItem, error)

+ RemoveUser func(context.Context, RemoveUserRequest) error

+ UpdateTFA func(context.Context, UpdateTFARequest) error

+ UpdateUserAuthGrants func(context.Context, UpdateUserAuthGrantsRequest) ([]AuthGrant, error)

+ UpdateUserInfo func(context.Context, UpdateUserInfoRequest) (*UserBasicInfo, error)

+ UpdateUserNotifications func(context.Context, UpdateUserNotificationsRequest) (*UserNotifications, error)

Other modules containing this package

github.com/akamai/AkamaiOPEN-edgegrid-golang/v2

github.com/akamai/AkamaiOPEN-edgegrid-golang/v3

github.com/akamai/AkamaiOPEN-edgegrid-golang/v4

github.com/akamai/AkamaiOPEN-edgegrid-golang/v5

github.com/akamai/AkamaiOPEN-edgegrid-golang/v6

github.com/akamai/AkamaiOPEN-edgegrid-golang/v7

github.com/akamai/AkamaiOPEN-edgegrid-golang/v9