package
0.89.3
Repository: https://github.com/arangodb-managed/apis.git
Documentation: pkg.go.dev

# Functions

APIKeyURL creates a resource URL for the APIKey with given ID in given context.
CreateMemberIDFromGroup creates a member ID from the given group.
CreateMemberIDFromGroupID creates a member ID from the given group ID.
CreateMemberIDFromUser creates a member ID from the given user.
CreateMemberIDFromUserID creates a member ID from the given user ID.
ForEachAPIKey iterates over all API keys of the authenticated user, invoking the given callback for each key.
ForEachGroup iterates over all groups in an organization identified by given context ID, invoking the given callback for each group.
ForEachGroupMember iterates over all members in the group identified by given context ID, invoking the given callback for each group member ID.
ForEachRole iterates over all roles in an organization identified by given context ID, invoking the given callback for each role.
GroupURL creates a resource URL for the Group with given ID in given context.
No description provided by the author
RegisterIAMServiceHandler registers the http handlers for service IAMService to "mux".
RegisterIAMServiceHandlerClient registers the http handlers for service IAMService to "mux".
RegisterIAMServiceHandlerFromEndpoint is same as RegisterIAMServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterIAMServiceHandlerServer registers the http handlers for service IAMService to "mux".
No description provided by the author
RoleURL creates a resource URL for the Role with given ID in given context.
UserURL creates a resource URL for the User with given ID.

# Constants

APIID contains identifier of this API.
APIMajorVersion contains major version of this API.
APIMinorVersion contains minor version of this API.
APIPatchVersion contains patch version of this API.
EducationalRoleOther constant for role other than student / teacher at educational institute.
EducationalRoleStudent constant for student role at educational institute.
EducationalRoleTeacher constant for teacher role at educational institute.
EventTypeAPIKeyCreated is the type of event fired after an API key has been created.
EventTypeAPIKeyDeleted is the type of event fired after an API key has been deleted.
EventTypeAPIKeyRevoked is the type of event fired after an API key has been revoked.
EventTypeGroupCreated is the type of event fired after a group has been created SubjectID contains the ID of the group.
EventTypeGroupDeleted is the type of event fired after a group has been (marked for) deleted SubjectID contains the ID of the group.
EventTypeGroupMemberAdded is the type of event fired after a member has been added to a group.
EventTypeGroupMemberRemoved is the type of event fired after a member has been removed from a group.
EventTypeGroupUpdated is the type of event fired after a group has been updated SubjectID contains the ID of the group.
EventTypePolicyUpdated is the type of event fired after a policy has been updated SubjectID contains the URL of the policy.
EventTypeRoleCreated is the type of event fired after a (custom) role has been created SubjectID contains the ID of the role.
EventTypeRoleDeleted is the type of event fired after a (custom) role has been (marked for) deleted SubjectID contains the ID of the role.
EventTypeRoleUpdated is the type of event fired after a (custom) role has been updated SubjectID contains the ID of the role.
KindAPIKey is a constants for the kind of APIKey resources.
KindGroup is a constants for the kind of Group resources.
KindRole is a constants for the kind of Role resources.
KindUser is a constants for the kind of User resources.
PermissionGroupCreate is needed for create a group in an organization.
PermissionGroupDelete is needed for deleting a group in an organization.
PermissionGroupGet is needed for fetching an individual group in an organization.
PermissionGroupList is needed for listing groups in an organization.
PermissionGroupUpdate is needed for updating a group in an organization.
PermissionPolicyGet is needed for fetching an individual policy on a resource.
PermissionPolicyUpdate is needed for updating a policy on a resource.
PermissionRoleCreate is needed for create a role in an organization.
PermissionRoleDelete is needed for deleting a role in an organization.
PermissionRoleGet is needed for fetching an individual role in an organization.
PermissionRoleList is needed for listing roles in an organization.
PermissionRoleUpdate is needed for updating a role in an organization.
PermissionUserGetPersonalData is needed for fetching a personal data such as mobile phone number for a user that is not the currently authenticated user.
PermissionUserUpdate is needed to update the data of a user (other than the currently authenticated user).

# Variables

No description provided by the author

# Structs

API Keys are authentication "keys" intended to be used for scripting.
List of APIKey's.
API key secrets are used once to inform the users of the secret for an API key.
Request arguments for AuthenticateAPIKey.
Response for AuthenticateAPIKey.
Request arguments for CreateAPIKey.
Request arguments for GetMultipleEffectivePermissions.
Request arguments for GetPolicyByFilter.
Group of user accounts.
List of groups.
List of group members (user ID's).
Request arguments for Add/DeleteGroupMembers.
Request arguments for HasPermissionsRequest.
Request arguments for IsMemberOfGroup.
Multiple Lists of permissions.
List of permissions.
Policy bindings members to roles for access to a resource.
Request arguments for RenewAPIKeyToken.
Response for RenewAPIKeyToken.
Request arguments for RevokeAPIKeyToken.
A role is a list of permissions.
RoleBinding binds a Role to a member.
Request arguments for Add/DeleteRoleBindings.
List of roles.
UnimplementedIAMServiceServer can be embedded to have forward compatible implementations.
User represents an actual person.
Request arguments for VerifyUserMobilePhone.

# Interfaces

IAMServiceClient is the client API for IAMService service.
IAMServiceServer is the server API for IAMService service.

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author