usermanagement

package
v2.36.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 23, 2024 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Code generated by tutone: DO NOT EDIT

Code generated by tutone: DO NOT EDIT

Index

Constants

View Source 
const UserManagementAddUsersToGroupsMutation = `` /* 238-byte string literal not displayed */
View Source 
const UserManagementCreateGroupMutation = `` /* 212-byte string literal not displayed */
View Source 
const UserManagementCreateUserMutation = `` /* 232-byte string literal not displayed */
View Source 
const UserManagementDeleteGroupMutation = `` /* 194-byte string literal not displayed */
View Source 
const UserManagementDeleteUserMutation = `` /* 158-byte string literal not displayed */
View Source 
const UserManagementRemoveUsersFromGroupsMutation = `` /* 259-byte string literal not displayed */
View Source 
const UserManagementUpdateGroupMutation = `` /* 212-byte string literal not displayed */
View Source 
const UserManagementUpdateUserMutation = `` /* 339-byte string literal not displayed */

Variables

View Source 
var OrganizationAuthenticationTypeEnumTypes = struct {
	// Authentication not configured
	DISABLED OrganizationAuthenticationTypeEnum
	// Heroku Single Sign-On
	HEROKU_SSO OrganizationAuthenticationTypeEnum
	// Oidc Single Sign-On
	OIDC_SSO OrganizationAuthenticationTypeEnum
	// Username and password authentication
	PASSWORD OrganizationAuthenticationTypeEnum
	// SAML Single Sign-On
	SAML_SSO OrganizationAuthenticationTypeEnum
}{

	DISABLED: "DISABLED",

	HEROKU_SSO: "HEROKU_SSO",

	OIDC_SSO: "OIDC_SSO",

	PASSWORD: "PASSWORD",

	SAML_SSO: "SAML_SSO",
}
View Source 
var OrganizationProvisioningTypeEnumTypes = struct {
	// Provisioning not configured
	DISABLED OrganizationProvisioningTypeEnum
	// Manual provisioning
	MANUAL OrganizationProvisioningTypeEnum
	// SCIM automated provisioning
	SCIM OrganizationProvisioningTypeEnum
}{

	DISABLED: "DISABLED",

	MANUAL: "MANUAL",

	SCIM: "SCIM",
}
View Source 
var UserManagementGroupSortKeyTypes = struct {
	// Sort by display name
	DISPLAY_NAME UserManagementGroupSortKey
	// Sort by ID
	ID UserManagementGroupSortKey
}{

	DISPLAY_NAME: "DISPLAY_NAME",

	ID: "ID",
}
View Source 
var UserManagementRequestedTierNameTypes = struct {
	// basic tier
	BASIC_USER_TIER UserManagementRequestedTierName
	// core tier
	CORE_USER_TIER UserManagementRequestedTierName
	// full tier
	FULL_USER_TIER UserManagementRequestedTierName
}{

	BASIC_USER_TIER: "BASIC_USER_TIER",

	CORE_USER_TIER: "CORE_USER_TIER",

	FULL_USER_TIER: "FULL_USER_TIER",
}
View Source 
var UserManagementSortDirectionTypes = struct {
	// Sort in ascending order
	ASCENDING UserManagementSortDirection
	// Sort in descending order
	DESCENDING UserManagementSortDirection
}{

	ASCENDING: "ASCENDING",

	DESCENDING: "DESCENDING",
}
View Source 
var UserManagementTypeEnumTypes = struct {
	// Basic type
	BASIC UserManagementTypeEnum
	// Core type
	CORE UserManagementTypeEnum
	// Full type
	FULL_PLATFORM UserManagementTypeEnum
}{

	BASIC: "BASIC",

	CORE: "CORE",

	FULL_PLATFORM: "FULL_PLATFORM",
}

Functions

This section is empty.

Types

type Actor 

type Actor struct {
	// The `organization` field is the entry point into data that is scoped to the user's organization.
	Organization Organization `json:"organization,omitempty"`
}

Actor - The `Actor` object contains fields that are scoped to the API user's access level.

type AuthorizationManagementAuthenticationDomain 

type AuthorizationManagementAuthenticationDomain struct {
	// container for groups enabling cursor based pagination
	Groups AuthorizationManagementGroupSearch `json:"groups"`
	// a value that uniquely identifies this object
	ID string `json:"id"`
	// the name of the object
	Name string `json:"name"`
}

AuthorizationManagementAuthenticationDomain - An "authentication domain" is a grouping of New Relic users governed by the same user management settings, like how they're provisioned (added and updated), how they're authenticated (logged in), session settings, and how user upgrades are managed.

type AuthorizationManagementAuthenticationDomainSearch 

type AuthorizationManagementAuthenticationDomainSearch struct {
	// containers of users and groups
	AuthenticationDomains []AuthorizationManagementAuthenticationDomain `json:"authenticationDomains"`
	// an opaque cursor to supply with subsequent   requests to get the next page of results, null if there are no more pages
	NextCursor string `json:"nextCursor,omitempty"`
	// the total number of results
	TotalCount int `json:"totalCount"`
}

AuthorizationManagementAuthenticationDomainSearch - container for authentication domains enabling cursor based pagination

type AuthorizationManagementGrantedRole 

type AuthorizationManagementGrantedRole struct {
	// the account that this role grants access to
	AccountID int `json:"accountId,omitempty"`
	// the name of the object
	DisplayName string `json:"displayName,omitempty"`
	// the group that this role grants access to
	GroupId string `json:"groupId,omitempty"`
	// a value that uniquely identifies this object
	ID string `json:"id"`
	// the name of the object
	Name string `json:"name"`
	// the organization this role grants access to
	OrganizationId string `json:"organizationId,omitempty"`
	// the role that defines this access
	RoleId int `json:"roleId"`
	// the type of the role
	Type string `json:"type"`
}

AuthorizationManagementGrantedRole - A Granted Role represents the access given to a group.

type AuthorizationManagementGrantedRoleSearch 

type AuthorizationManagementGrantedRoleSearch struct {
	// an opaque cursor to supply with subsequent   requests to get the next page of results, null if there are no more pages
	NextCursor string `json:"nextCursor,omitempty"`
	// the roles granted to this group
	Roles []AuthorizationManagementGrantedRole `json:"roles"`
	// the total number of results
	TotalCount int `json:"totalCount"`
}

AuthorizationManagementGrantedRoleSearch - container for roles enabling cursor based pagination

type AuthorizationManagementGroup 

type AuthorizationManagementGroup struct {
	// the name of the object
	DisplayName string `json:"displayName"`
	// a value that uniquely identifies this object
	ID string `json:"id"`
	// container for roles enabling cursor based pagination
	Roles AuthorizationManagementGrantedRoleSearch `json:"roles"`
}

AuthorizationManagementGroup - For users on our New Relic One user model, a "group" represents a group of users. Putting users in a group allows the managing of permissions for multiple users at the same time.

type AuthorizationManagementGroupSearch 

type AuthorizationManagementGroupSearch struct {
	// contains roles granted to users's groups
	Groups []AuthorizationManagementGroup `json:"groups"`
	// an opaque cursor to supply with subsequent   requests to get the next page of results, null if there are no more pages
	NextCursor string `json:"nextCursor,omitempty"`
	// the total number of results
	TotalCount int `json:"totalCount"`
}

AuthorizationManagementGroupSearch - container for groups enabling cursor based pagination

type Organization 

type Organization struct {
	// The customer id for the organization.
	CustomerId string `json:"customerId,omitempty"`
	// The name of the organization.
	Name string `json:"name,omitempty"`
	// The telemetry id for the organization
	TelemetryId string `json:"telemetryId,omitempty"`
	// This field provides access to UserManagement data.
	UserManagement UserManagementOrganizationStitchedFields `json:"userManagement,omitempty"`
}

Organization - The `Organization` object provides basic data about an organization.

type OrganizationAuthenticationDomain 

type OrganizationAuthenticationDomain struct {
	// Method of authenticating users
	AuthenticationType OrganizationAuthenticationTypeEnum `json:"authenticationType"`
	// The authentication domain id
	ID string `json:"id"`
	// The authentication domain name
	Name string `json:"name"`
	// The organization the authentication domain belongs to
	OrganizationId string `json:"organizationId"`
	// Method of provisioning users
	ProvisioningType OrganizationProvisioningTypeEnum `json:"provisioningType"`
}

OrganizationAuthenticationDomain - A grouping of users governed by the same user management settings

type OrganizationAuthenticationDomainCollection 

type OrganizationAuthenticationDomainCollection struct {
	// Authentication domains
	Items []OrganizationAuthenticationDomain `json:"items"`
	// an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pages
	NextCursor string `json:"nextCursor,omitempty"`
}

OrganizationAuthenticationDomainCollection - Authentication domains

type OrganizationAuthenticationTypeEnum 

type OrganizationAuthenticationTypeEnum string

OrganizationAuthenticationTypeEnum - Provides the available values for authentication type

type OrganizationProvisioningTypeEnum 

type OrganizationProvisioningTypeEnum string

OrganizationProvisioningTypeEnum - Provides the available values for provisioning type

type UserManagementAddUsersToGroupsPayload added in v2.25.0 

type UserManagementAddUsersToGroupsPayload struct {
	// The group(s) updated.
	Groups []UserManagementGroup `json:"groups"`
}

UserManagementAddUsersToGroupsPayload - Autogenerated return type of AddUsersToGroups.

type UserManagementAddUsersToGroupsQueryResponse added in v2.25.0 

type UserManagementAddUsersToGroupsQueryResponse struct {
	UserManagementAddUsersToGroupsPayload UserManagementAddUsersToGroupsPayload `json:"UserManagementAddUsersToGroups"`
}

type UserManagementAuthenticationDomain 

type UserManagementAuthenticationDomain struct {
	// container for groups enabling cursor based pagination
	Groups UserManagementGroups `json:"groups,omitempty"`
	// a value that uniquely identifies this object
	ID string `json:"id"`
	// the name of the object
	Name string `json:"name"`
	// the method used to provision users in this authentication domain
	ProvisioningType string `json:"provisioningType"`
	// container for users enabling cursor based pagination
	Users UserManagementUsers `json:"users,omitempty"`
}

UserManagementAuthenticationDomain - An "authentication domain" is a grouping of New Relic users governed by the same user management settings, like how they're provisioned (added and updated), how they're authenticated (logged in), session settings, and how user upgrades are managed.

type UserManagementAuthenticationDomains 

type UserManagementAuthenticationDomains struct {
	// container for authentication_domains enabling cursor based pagination
	AuthenticationDomains []UserManagementAuthenticationDomain `json:"authenticationDomains"`
	// an opaque cursor to supply with subsequent     requests to get the next page of results, null if there are no more pages
	NextCursor string `json:"nextCursor,omitempty"`
	// the total number of results
	TotalCount int `json:"totalCount"`
}

UserManagementAuthenticationDomains - container for authentication domains enabling cursor based pagination

type UserManagementCreateGroup added in v2.25.0 

type UserManagementCreateGroup struct {
	// The id of the authentication domain the group will belong to
	AuthenticationDomainId string `json:"authenticationDomainId"`
	// The name of the group
	DisplayName string `json:"displayName"`
}

UserManagementCreateGroup - The input object representing the group being created

type UserManagementCreateGroupPayload added in v2.25.0 

type UserManagementCreateGroupPayload struct {
	// The group that was created
	Group UserManagementGroup `json:"group,omitempty"`
}

UserManagementCreateGroupPayload - Autogenerated return type of CreateGroup.

type UserManagementCreateGroupQueryResponse added in v2.25.0 

type UserManagementCreateGroupQueryResponse struct {
	UserManagementCreateGroupPayload UserManagementCreateGroupPayload `json:"UserManagementCreateGroup"`
}

type UserManagementCreateUser added in v2.25.0 

type UserManagementCreateUser struct {
	// The authentication domain id for the user to be created under.
	AuthenticationDomainId string `json:"authenticationDomainId"`
	// The email address of the user to be created.
	Email string `json:"email"`
	// The name of the user to be created.
	Name string `json:"name"`
	// The user type for the user to be created.
	UserType UserManagementRequestedTierName `json:"userType,omitempty"`
}

UserManagementCreateUser - The input object representing the user being created

type UserManagementCreateUserPayload added in v2.25.0 

type UserManagementCreateUserPayload struct {
	// The user that was created
	CreatedUser UserManagementCreatedUser `json:"createdUser,omitempty"`
}

UserManagementCreateUserPayload - Autogenerated return type of CreateUser.

type UserManagementCreateUserQueryResponse added in v2.25.0 

type UserManagementCreateUserQueryResponse struct {
	UserManagementCreateUserPayload UserManagementCreateUserPayload `json:"UserManagementCreateUser"`
}

type UserManagementCreatedUser added in v2.25.0 

type UserManagementCreatedUser struct {
	// Authentication domain of the created user.
	AuthenticationDomainId string `json:"authenticationDomainId,omitempty"`
	// Email address of the created user.
	Email string `json:"email"`
	// The ID of the created user.
	ID string `json:"id"`
	// The full name of the created user.
	Name string `json:"name"`
	// A "user type" is what determines the set of New Relic capabilities a user can theoretically access.
	Type UserManagementUserType `json:"type"`
}

UserManagementCreatedUser - A newly created user of New Relic scoped to an authentication domain.

type UserManagementDeleteGroup added in v2.25.0 

type UserManagementDeleteGroup struct {
	// The ID of the group being removed.
	ID string `json:"id"`
}

UserManagementDeleteGroup - The input object representing the group to remove

type UserManagementDeleteGroupPayload added in v2.25.0 

type UserManagementDeleteGroupPayload struct {
	// The group that was deleted
	Group UserManagementGroup `json:"group,omitempty"`
}

UserManagementDeleteGroupPayload - Autogenerated return type of DeleteGroup.

type UserManagementDeleteGroupQueryResponse added in v2.25.0 

type UserManagementDeleteGroupQueryResponse struct {
	UserManagementDeleteGroupPayload UserManagementDeleteGroupPayload `json:"UserManagementDeleteGroup"`
}

type UserManagementDeleteUser added in v2.25.0 

type UserManagementDeleteUser struct {
	// The ID of the user to be deleted
	ID string `json:"id"`
}

UserManagementDeleteUser - The input object representing the user being deleted

type UserManagementDeleteUserPayload added in v2.25.0 

type UserManagementDeleteUserPayload struct {
	// The user that was deleted
	DeletedUser UserManagementDeletedUser `json:"deletedUser,omitempty"`
}

UserManagementDeleteUserPayload - Autogenerated return type of DeleteUser.

type UserManagementDeleteUserQueryResponse added in v2.25.0 

type UserManagementDeleteUserQueryResponse struct {
	UserManagementDeleteUserPayload UserManagementDeleteUserPayload `json:"UserManagementDeleteUser"`
}

type UserManagementDeletedUser added in v2.25.0 

type UserManagementDeletedUser struct {
	// The id of the deleted user
	ID string `json:"id"`
}

UserManagementDeletedUser - A user of New Relic to be deleted.

type UserManagementDisplayNameInput 

type UserManagementDisplayNameInput struct {
	// Part of a display name
	Contains string `json:"contains,omitempty"`
	// A display name
	Eq string `json:"eq,omitempty"`
}

UserManagementDisplayNameInput - Available filtering types for group display names

type UserManagementEmailInput 

type UserManagementEmailInput struct {
	// Part of a user email
	Contains string `json:"contains,omitempty"`
	// A user email
	Eq string `json:"eq,omitempty"`
}

UserManagementEmailInput - Available filtering types for email addresses

type UserManagementEmailVerificationStateInput 

type UserManagementEmailVerificationStateInput struct {
	// An email verification state
	Pending bool `json:"pending"`
}

UserManagementEmailVerificationStateInput - Available filtering types for email verification states

type UserManagementGroup 

type UserManagementGroup struct {
	// the name of the object
	DisplayName string `json:"displayName"`
	// a value that uniquely identifies this object
	ID string `json:"id"`
	// container for users enabling cursor based pagination
	Users UserManagementGroupUsers `json:"users,omitempty"`
}

UserManagementGroup - For users on our New Relic One user model, a "group" represents a group of users. Putting users in a group allows the managing of permissions for multiple users at the same time.

type UserManagementGroupFilterInput 

type UserManagementGroupFilterInput struct {
	// Filter groups by display name
	DisplayName UserManagementDisplayNameInput `json:"displayName,omitempty"`
	// Filter groups by group ID
	ID UserManagementGroupIdInput `json:"id,omitempty"`
}

UserManagementGroupFilterInput - The input object representing the filter parameters for groups

type UserManagementGroupIdInput 

type UserManagementGroupIdInput struct {
	// A group ID
	Eq string `json:"eq,omitempty"`
	// An array of group IDs
	In []string `json:"in"`
}

UserManagementGroupIdInput - Available filtering types for group IDs

type UserManagementGroupSortInput 

type UserManagementGroupSortInput struct {
	// Sort groups in this direction
	Direction UserManagementSortDirection `json:"direction,omitempty"`
	// Sort groups by this key
	Key UserManagementGroupSortKey `json:"key,omitempty"`
}

UserManagementGroupSortInput - The input object representing the sort parameters for groups

type UserManagementGroupSortKey 

type UserManagementGroupSortKey string

UserManagementGroupSortKey - Available keys for sorting groups

type UserManagementGroupUser 

type UserManagementGroupUser struct {
	// The email of the user.
	Email string `json:"email"`
	// a value that uniquely identifies this object
	ID string `json:"id"`
	// The full name of the user.
	Name string `json:"name"`
	// The configured time zone of the user.
	TimeZone string `json:"timeZone"`
}

UserManagementGroupUser - User information returned within Groups

type UserManagementGroupUsers 

type UserManagementGroupUsers struct {
	// an opaque cursor to supply with subsequent     requests to get the next page of results, null if there are no more pages
	NextCursor string `json:"nextCursor,omitempty"`
	// the total number of results
	TotalCount int `json:"totalCount"`
	// container for users enabling cursor based pagination
	Users []UserManagementGroupUser `json:"users"`
}

UserManagementGroupUsers - container for users enabling cursor based pagination

type UserManagementGroups 

type UserManagementGroups struct {
	// container for groups enabling cursor based pagination
	Groups []UserManagementGroup `json:"groups"`
	// an opaque cursor to supply with subsequent     requests to get the next page of results, null if there are no more pages
	NextCursor string `json:"nextCursor,omitempty"`
	// the total number of results
	TotalCount int `json:"totalCount"`
}

UserManagementGroups - container for groups enabling cursor based pagination

type UserManagementNameInput 

type UserManagementNameInput struct {
	// Part of a user name
	Contains string `json:"contains,omitempty"`
	// A user name
	Eq string `json:"eq,omitempty"`
}

UserManagementNameInput - Available filtering types for names

type UserManagementOrganizationStitchedFields 

type UserManagementOrganizationStitchedFields struct {
	// An "authentication domain" is a grouping of New Relic users governed by the same user management settings, like how they're provisioned (added and updated), how they're authenticated (logged in), session settings, and how user upgrades are managed.
	AuthenticationDomains UserManagementAuthenticationDomains `json:"authenticationDomains,omitempty"`
}

type UserManagementPendingUpgradeRequest 

type UserManagementPendingUpgradeRequest struct {
	// a value that uniquely identifies this object
	ID string `json:"id"`
	// Requester message, why the user believes they require the upgrade.
	Message string `json:"message,omitempty"`
	// Requested user type for the user.
	RequestedUserType UserManagementUserType `json:"requestedUserType,omitempty"`
}

UserManagementPendingUpgradeRequest - Exists only if a user has a pending upgrade request.

type UserManagementPendingUpgradeRequestInput 

type UserManagementPendingUpgradeRequestInput struct {
	// Whether a request exists or not
	Exists bool `json:"exists"`
}

UserManagementPendingUpgradeRequestInput - Available filtering types for pending upgrade requests

type UserManagementRemoveUsersFromGroupsPayload added in v2.25.0 

type UserManagementRemoveUsersFromGroupsPayload struct {
	// The group(s) updated.
	Groups []UserManagementGroup `json:"groups"`
}

UserManagementRemoveUsersFromGroupsPayload - Autogenerated return type of RemoveUsersFromGroups.

type UserManagementRemoveUsersFromGroupsQueryResponse added in v2.25.0 

type UserManagementRemoveUsersFromGroupsQueryResponse struct {
	UserManagementRemoveUsersFromGroupsPayload UserManagementRemoveUsersFromGroupsPayload `json:"UserManagementRemoveUsersFromGroups"`
}

type UserManagementRequestedTierName added in v2.25.0 

type UserManagementRequestedTierName string

UserManagementRequestedTierName - Valid request types for user change requests

type UserManagementSortDirection 

type UserManagementSortDirection string

UserManagementSortDirection - Available directions for sorting

type UserManagementTypeEnum 

type UserManagementTypeEnum string

UserManagementTypeEnum - Available values for Type

type UserManagementTypeInput 

type UserManagementTypeInput struct {
	// A user type
	Eq UserManagementTypeEnum `json:"eq"`
}

UserManagementTypeInput - Available filtering types for user type

type UserManagementUpdateGroup added in v2.25.0 

type UserManagementUpdateGroup struct {
	// The name of the group
	DisplayName string `json:"displayName"`
	// The id of the group to update
	ID string `json:"id"`
}

UserManagementUpdateGroup - The input object representing the group being updated

type UserManagementUpdateGroupPayload added in v2.25.0 

type UserManagementUpdateGroupPayload struct {
	// The group that was updated
	Group UserManagementGroup `json:"group,omitempty"`
}

UserManagementUpdateGroupPayload - Autogenerated return type of UpdateGroup.

type UserManagementUpdateGroupQueryResponse added in v2.25.0 

type UserManagementUpdateGroupQueryResponse struct {
	UserManagementUpdateGroupPayload UserManagementUpdateGroupPayload `json:"UserManagementUpdateGroup"`
}

type UserManagementUpdateUser added in v2.25.0 

type UserManagementUpdateUser struct {
	// The new email address to be updated on the user
	Email string `json:"email,omitempty"`
	// The ID of the user to be updated
	ID string `json:"id"`
	// The full name of the user to be updated
	Name string `json:"name,omitempty"`
	// The user time zone to be updated, in IANA zoneinfo format, e.g. 'America/Chicago'
	TimeZone string `json:"timeZone,omitempty"`
	// The new user type to be updated on the user
	UserType UserManagementRequestedTierName `json:"userType,omitempty"`
}

UserManagementUpdateUser - The input object representing the user being updated

type UserManagementUpdateUserPayload added in v2.25.0 

type UserManagementUpdateUserPayload struct {
	// The user that was updated
	User UserManagementUser `json:"user,omitempty"`
}

UserManagementUpdateUserPayload - Autogenerated return type of UpdateUser.

type UserManagementUpdateUserQueryResponse added in v2.25.0 

type UserManagementUpdateUserQueryResponse struct {
	UserManagementUpdateUserPayload UserManagementUpdateUserPayload `json:"UserManagementUpdateUser"`
}

type UserManagementUser 

type UserManagementUser struct {
	// Email address of the user.
	Email string `json:"email,omitempty"`
	// One of: "Not Verifiable", "Verified", and "Pending".
	//
	// Not Verifiable: the user's email does not require verification.
	//
	// Verified: the user's email requires verification and has been.
	//
	// Pending: the user's email requires verification and has not been.
	EmailVerificationState string `json:"emailVerificationState"`
	// container for groups enabling cursor based pagination
	Groups UserManagementUserGroups `json:"groups,omitempty"`
	// a value that uniquely identifies this object
	ID string `json:"id"`
	// The last active date of the user.
	LastActive nrtime.DateTime `json:"lastActive,omitempty"`
	// The full name of the user.
	Name string `json:"name,omitempty"`
	// The pending upgrade request for the user (if any).
	PendingUpgradeRequest UserManagementPendingUpgradeRequest `json:"pendingUpgradeRequest,omitempty"`
	// Time zone of the user in IANA Time Zone database format, also known as the "Olson" time zone database format (for exmaple, "America/Los_Angeles").
	TimeZone string `json:"timeZone,omitempty"`
	// A "user type" is what determines the set of New Relic capabilities a user can theoretically access.
	Type UserManagementUserType `json:"type"`
}

UserManagementUser - A user of New Relic scoped to an authentication domain.

type UserManagementUserFilterInput 

type UserManagementUserFilterInput struct {
	// Filter users by email address
	Email UserManagementEmailInput `json:"email,omitempty"`
	// Filter users by email verification state
	EmailVerificationState UserManagementEmailVerificationStateInput `json:"emailVerificationState,omitempty"`
	// Filter users by user ID
	ID UserManagementUserIdInput `json:"id,omitempty"`
	// Filter users by name
	Name UserManagementNameInput `json:"name,omitempty"`
	// Filter users by pending upgrade request
	PendingUpgradeRequest UserManagementPendingUpgradeRequestInput `json:"pendingUpgradeRequest,omitempty"`
	// Filter users by type
	Type UserManagementTypeInput `json:"type,omitempty"`
}

UserManagementUserFilterInput - The input object representing the filter parameters for users

type UserManagementUserGroup 

type UserManagementUserGroup struct {
	// the name of the object
	DisplayName string `json:"displayName"`
	// a value that uniquely identifies this object
	ID string `json:"id"`
}

UserManagementUserGroup - For users on our New Relic One user model, a "group" represents a group of users. Putting users in a group allows the managing of permissions for multiple users at the same time.

type UserManagementUserGroups 

type UserManagementUserGroups struct {
	// container for groups enabling cursor based pagination
	Groups []UserManagementUserGroup `json:"groups"`
	// an opaque cursor to supply with subsequent     requests to get the next page of results, null if there are no more pages
	NextCursor string `json:"nextCursor,omitempty"`
	// the total number of results
	TotalCount int `json:"totalCount"`
}

UserManagementUserGroups - container for groups enabling cursor based pagination

type UserManagementUserIdInput 

type UserManagementUserIdInput struct {
	// A user ID
	Eq string `json:"eq,omitempty"`
	// An array of user IDs
	In []string `json:"in"`
}

UserManagementUserIdInput - Available filtering types for user IDs

type UserManagementUserType 

type UserManagementUserType struct {
	// the name of the object
	DisplayName string `json:"displayName"`
	// a value that uniquely identifies this object
	ID string `json:"id"`
}

UserManagementUserType - A "user type" is what determines the set of New Relic capabilities a user can theoretically access.

type UserManagementUsers 

type UserManagementUsers struct {
	// an opaque cursor to supply with subsequent     requests to get the next page of results, null if there are no more pages
	NextCursor string `json:"nextCursor,omitempty"`
	// the total number of results
	TotalCount int `json:"totalCount"`
	// container for users enabling cursor based pagination
	Users []UserManagementUser `json:"users"`
}

UserManagementUsers - container for users enabling cursor based pagination

type UserManagementUsersGroupsInput added in v2.25.0 

type UserManagementUsersGroupsInput struct {
	// The id of the group(s) to add the user(s) to. Max: 10
	GroupIds []string `json:"groupIds"`
	// The id of the user(s) to be added to the group(s). Max: 50
	UserIDs []string `json:"userIds"`
}

UserManagementUsersGroupsInput - The input object representing the group(s) and user(s) to update.

type Usermanagement added in v2.25.0 

type Usermanagement struct {
	// contains filtered or unexported fields
}

func New 

func New(config config.Config) Usermanagement

func (*Usermanagement) GetAuthenticationDomains added in v2.25.0 

func (a *Usermanagement) GetAuthenticationDomains(
	cursor string,
	iD []string,
) (*UserManagementAuthenticationDomains, error)

An "authentication domain" is a grouping of New Relic users governed by the same user management settings, like how they're provisioned (added and updated), how they're authenticated (logged in), session settings, and how user upgrades are managed.

func (*Usermanagement) GetAuthenticationDomainsWithContext added in v2.25.0 

func (a *Usermanagement) GetAuthenticationDomainsWithContext(
	ctx context.Context,
	cursor string,
	iD []string,
) (*UserManagementAuthenticationDomains, error)

An "authentication domain" is a grouping of New Relic users governed by the same user management settings, like how they're provisioned (added and updated), how they're authenticated (logged in), session settings, and how user upgrades are managed.

func (*Usermanagement) UserManagementAddUsersToGroups added in v2.25.0 

func (a *Usermanagement) UserManagementAddUsersToGroups(
	addUsersToGroupsOptions UserManagementUsersGroupsInput,
) (*UserManagementAddUsersToGroupsPayload, error)

A mutation for adding user(s) to group(s).

func (*Usermanagement) UserManagementAddUsersToGroupsWithContext added in v2.25.0 

func (a *Usermanagement) UserManagementAddUsersToGroupsWithContext(
	ctx context.Context,
	addUsersToGroupsOptions UserManagementUsersGroupsInput,
) (*UserManagementAddUsersToGroupsPayload, error)

A mutation for adding user(s) to group(s).

func (*Usermanagement) UserManagementCreateGroup added in v2.25.0 

func (a *Usermanagement) UserManagementCreateGroup(
	createGroupOptions UserManagementCreateGroup,
) (*UserManagementCreateGroupPayload, error)

A mutation for creating a group in an authentication domain.

func (*Usermanagement) UserManagementCreateGroupWithContext added in v2.25.0 

func (a *Usermanagement) UserManagementCreateGroupWithContext(
	ctx context.Context,
	createGroupOptions UserManagementCreateGroup,
) (*UserManagementCreateGroupPayload, error)

A mutation for creating a group in an authentication domain.

func (*Usermanagement) UserManagementCreateUser added in v2.25.0 

func (a *Usermanagement) UserManagementCreateUser(
	createUserOptions UserManagementCreateUser,
) (*UserManagementCreateUserPayload, error)

A mutation for creating a user in an authentication domain.

func (*Usermanagement) UserManagementCreateUserWithContext added in v2.25.0 

func (a *Usermanagement) UserManagementCreateUserWithContext(
	ctx context.Context,
	createUserOptions UserManagementCreateUser,
) (*UserManagementCreateUserPayload, error)

A mutation for creating a user in an authentication domain.

func (*Usermanagement) UserManagementDeleteGroup added in v2.25.0 

func (a *Usermanagement) UserManagementDeleteGroup(
	groupOptions UserManagementDeleteGroup,
) (*UserManagementDeleteGroupPayload, error)

A mutation for deleting a group.

func (*Usermanagement) UserManagementDeleteGroupWithContext added in v2.25.0 

func (a *Usermanagement) UserManagementDeleteGroupWithContext(
	ctx context.Context,
	groupOptions UserManagementDeleteGroup,
) (*UserManagementDeleteGroupPayload, error)

A mutation for deleting a group.

func (*Usermanagement) UserManagementDeleteUser added in v2.25.0 

func (a *Usermanagement) UserManagementDeleteUser(
	deleteUserOptions UserManagementDeleteUser,
) (*UserManagementDeleteUserPayload, error)

A mutation for deleting a user.

func (*Usermanagement) UserManagementDeleteUserWithContext added in v2.25.0 

func (a *Usermanagement) UserManagementDeleteUserWithContext(
	ctx context.Context,
	deleteUserOptions UserManagementDeleteUser,
) (*UserManagementDeleteUserPayload, error)

A mutation for deleting a user.

func (*Usermanagement) UserManagementGetGroupsWithUsers added in v2.25.0 

func (a *Usermanagement) UserManagementGetGroupsWithUsers(
	authenticationDomainIDs []string,
	groupIDs []string,
	name string,
) (*UserManagementAuthenticationDomains, error)

func (*Usermanagement) UserManagementGetGroupsWithUsersWithContext added in v2.25.0 

func (a *Usermanagement) UserManagementGetGroupsWithUsersWithContext(
	ctx context.Context,
	authenticationDomainIDs []string,
	groupIDs []string,
	name string,
) (*UserManagementAuthenticationDomains, error)

func (*Usermanagement) UserManagementGetUsers added in v2.25.0 

func (a *Usermanagement) UserManagementGetUsers(
	authenticationDomainIDs []string,
	userIDs []string,
	name string,
	emailID string,
) (*UserManagementAuthenticationDomains, error)

func (*Usermanagement) UserManagementGetUsersWithContext added in v2.25.0 

func (a *Usermanagement) UserManagementGetUsersWithContext(
	ctx context.Context,
	authenticationDomainIDs []string,
	userIDs []string,
	name string,
	emailID string,
) (*UserManagementAuthenticationDomains, error)

func (*Usermanagement) UserManagementRemoveUsersFromGroups added in v2.25.0 

func (a *Usermanagement) UserManagementRemoveUsersFromGroups(
	removeUsersFromGroupsOptions UserManagementUsersGroupsInput,
) (*UserManagementRemoveUsersFromGroupsPayload, error)

A mutation for removing user(s) from group(s).

func (*Usermanagement) UserManagementRemoveUsersFromGroupsWithContext added in v2.25.0 

func (a *Usermanagement) UserManagementRemoveUsersFromGroupsWithContext(
	ctx context.Context,
	removeUsersFromGroupsOptions UserManagementUsersGroupsInput,
) (*UserManagementRemoveUsersFromGroupsPayload, error)

A mutation for removing user(s) from group(s).

func (*Usermanagement) UserManagementUpdateGroup added in v2.25.0 

func (a *Usermanagement) UserManagementUpdateGroup(
	updateGroupOptions UserManagementUpdateGroup,
) (*UserManagementUpdateGroupPayload, error)

A mutation for updating an existing group.

func (*Usermanagement) UserManagementUpdateGroupWithContext added in v2.25.0 

func (a *Usermanagement) UserManagementUpdateGroupWithContext(
	ctx context.Context,
	updateGroupOptions UserManagementUpdateGroup,
) (*UserManagementUpdateGroupPayload, error)

A mutation for updating an existing group.

func (*Usermanagement) UserManagementUpdateUser added in v2.25.0 

func (a *Usermanagement) UserManagementUpdateUser(
	updateUserOptions UserManagementUpdateUser,
) (*UserManagementUpdateUserPayload, error)

A mutation for updating an existing user.

func (*Usermanagement) UserManagementUpdateUserWithContext added in v2.25.0 

func (a *Usermanagement) UserManagementUpdateUserWithContext(
	ctx context.Context,
	updateUserOptions UserManagementUpdateUser,
) (*UserManagementUpdateUserPayload, error)

A mutation for updating an existing user.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.