organization

Documentation

Index

• type CreateUpdateMemberRequest
• type InviteMembersRequest
• type Member
• type MemberSearchResults
• type Organization
• type UpdateMemberRequest

Types

type CreateUpdateMemberRequest

type CreateUpdateMemberRequest struct {
	// Users's email address. SignalFx sends a special \"join\" link to the address; this is the only way that the user can join the organization.
	Email string `json:"email,omitempty"`
	// Users's full name
	FullName string `json:"fullName,omitempty"`
	// Users's job title
	Title string `json:"title,omitempty"`
	// Users's telephone number
	Phone string `json:"phone,omitempty"`
	// Flag that indicates if the user should get administrative access to the organization. If `true`,  SignalFx gives administrative access after the user joins.
	Admin bool `json:"admin,omitempty"`
}

type InviteMembersRequest

type InviteMembersRequest struct {
	// Array of member objects for the members that the request invited.
	Members []*Member `json:"members,omitempty"`
}

type Member

type Member struct {
	// SignalFx-assigned ID of the user that created this member
	Creator string `json:"creator,omitempty"`
	// SignalFx-assigned ID of the user that last updated this member
	LastUpdatedBy string `json:"lastUpdatedBy,omitempty"`
	// The member creation date and time, in Unix time UTC-relative. The  system sets this value, and you can't change it.
	Created int64 `json:"created,omitempty"`
	// The date and time that the member was last updated, in Unix time  UTC-relative. The system sets this value, and you can't change it.
	LastUpdated int64 `json:"lastUpdated,omitempty"`
	// SignalFx-assigned ID of the member
	Id string `json:"id,omitempty"`
	// SignalFx-assigned user ID for this member
	UserId string `json:"userId,omitempty"`
	// SignalFx-assigned organization ID for the organization that the member belongs to
	OrganizationId string `json:"organizationId,omitempty"`
	// Email address for the SignalFx user associated with this member record
	Email string `json:"email,omitempty"`
	// Full name of the user associated with this member record
	FullName string `json:"fullName,omitempty"`
	// Phone number of the user associated with this member record
	Phone string `json:"phone,omitempty"`
	// Job title of the user associated with this member record
	Title string `json:"title,omitempty"`
	// Administrator status flag. If `true`, this member has administrative authorization for the organization.
	Admin bool `json:"admin,omitempty"`
}

Properties containing data that SignalFx maintains for each member of an organization.

type MemberSearchResults

type MemberSearchResults struct {
	// Array of members. Each element contains a single result for the query, in the form of a member object.
	Results []*Member `json:"results,omitempty"`
	// The number of member objects in the result set produced by the query.<br> **NOTE:** This number is not necessarily the same as the number of objects returned to you. If you specify an offset or limit for the query, the number of objects you receive is less than `count`.
	Count int32 `json:"count,omitempty"`
}

The results of a GET for `/organization/member`. This is a JSON object that has two properties:<br> * `results`: Array of member objects * `count`: Number of member objects in the result set

type Organization

type Organization struct {
	// SignalFx-assigned ID of the user that created the organization object.
	Creator string `json:"creator,omitempty"`
	// SignalFx-assigned ID of the user that last updated the organization object.
	LastUpdatedBy string `json:"lastUpdatedBy,omitempty"`
	// The organization creation date and time, in Unix time UTC-relative.  The system sets this value, and you can't change it.
	Created int64 `json:"created,omitempty"`
	// The date and time that the organization was last updated, in Unix  time UTC-relative. The system sets this value, and you can't change it.
	LastUpdated int64 `json:"lastUpdated,omitempty"`
	// SignalFx-assigned ID for this organization
	Id string `json:"id,omitempty"`
	// The organization access token (referred to in the web UI as the **access token**) for this organization
	ApiAccessToken string `json:"apiAccessToken,omitempty"`
	// Descriptive name of the organization
	OrganizationName string `json:"organizationName,omitempty"`
	// The type of account for the customer that owns the organization
	AccountType string `json:"accountType,omitempty"`
	// Specifies the status of the account that owns the organization
	AccountStatus string `json:"accountStatus,omitempty"`
	// The authentication key for the account that owns the organization.
	AccountKey string `json:"accountKey,omitempty"`
	// The renewal status for the account that owns the organization
	AccountRenews bool `json:"accountRenews,omitempty"`
	// Specifies a date and time after which the account that owns the organization becomes invalid, in Unix time UTC-relative.
	AccountValidUntil int64 `json:"accountValidUntil,omitempty"`
	// Specifies the number of datapoints per minute that the  organization can receive.
	DpmLimit int32 `json:"dpmLimit,omitempty"`
}

Properties of your SignalFx organization

type UpdateMemberRequest

type UpdateMemberRequest struct {
	// Flag that indicates if the user should get administrative access to the organization. If `true`,  SignalFx gives administrative access after the user joins.
	Admin bool `json:"admin"`
}