SignalFx Developers Guide

Developer Home

Product Docs

SignalFx

Organizations API

API for adding, retrieving, updating, and deleting members in a SignalFx organization.
NOTE: You need administrator authorization to add members, delete members, and update the list of members in an organization.

Overview

Data coming in to SignalFx is associated with a single entity called an organization To access this data within an organization, users must be members of the organization. Most SignalFx users belong to a single organization, which they think of as their "SignalFx account".
All SignalFx users have user IDs that SignalFx assigns, which identifies the them across organizations at SignalFx. The SignalFx users for an organization also have a *member ID that's specific to the organization.
To join an organization, SignalFx users need an invitation from an member that has administrative access to the organization. After users join an organization, they can do the following for the organization:

  • Submit datapoints to their organization
  • Use the SignalFx web UI to look at their organization's data
  • Make requests with the SignalFx API to work with organization data

Retrieve Organization

Gets the organization object

get /organization

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https://api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/organization

Gets the organization object for your organization. You can only get the object if you're a member of the organization; SignalFx looks at the access token you use in your request to determine your membership.

header Parameters
Content-Type
required
string

Format of the request payload. The only allowed value is 'application/json'

X-SF-Token
required
string

A valid access token.

Responses

200

Successful retrieval of the organization object

Response Schema: application/json
creator
string (SignalFx ID of the organization creator)

SignalFx-assigned ID of the user that created the organization object.

lastUpdatedBy
string (SignalFx ID of the user who last updated the organization object.)

SignalFx-assigned ID of the user that last updated the organization object.

created
integer <int64> (Organization creation time)

The organization creation date and time, in Unix time UTC-relative. The system sets this value, and you can't change it.

lastUpdated
integer <int64> (Organization last updated time)

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.

id
string (The SignalFx-assigned organization ID)

SignalFx-assigned ID for this organization

apiAccessToken
string (The org access token for this org)

The organization access token (referred to in the web UI as the access token) for this organization

organizationName
string (Organization name)

Descriptive name of the organization

accountType
string (Account type for the organization)

The type of account for the customer that owns the organization

accountStatus
string (Account status for the organization)

Specifies the status of the account that owns the organization

accountKey
string (Account key for the organization)

The authentication key for the account that owns the organization.

accountRenews
string (Account renewal status for the organization)

The renewal status for the account that owns the organization

accountValidUntil
integer <int64> (Account validity date and time for the organization.)

Specifies a date and time after which the account that owns the organization becomes invalid, in Unix time UTC-relative.

dpmLimit
integer <int32> (Limit of the number of datapoints per minute)

Specifies the number of datapoints per minute that the organization can receive.

Response samples

application/json
Copy
Expand all Collapse all
{
  • "creator": "string",
  • "lastUpdatedBy": "string",
  • "created": 1531690230000,
  • "lastUpdated": 1554240630000,
  • "id": "string",
  • "apiAccessToken": "string",
  • "organizationName": "string",
  • "accountType": "string",
  • "accountStatus": "string",
  • "accountKey": "string",
  • "accountRenews": "string",
  • "accountValidUntil": 1626384630000,
  • "dpmLimit": 0
}

Retrieve Organization Members

Retrieves members of the organization

get /organization/member

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https://api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/organization/member

Retrieves one or more members of the organization, based on the search criteria specified in the query parameters.

query Parameters
offset
integer <int32>

The object in the result set at which the API should start returning results to you. Each object the SignalFx ID of an organization member.

limit
integer <int32>

The number of results to return from the result set.

query
string

Search criteria that selects the members you want the API to return. You can search for values of any of the properties of an organization object.

Search criteria have the following rules:

  • To search for a property, specify its name. The result is all of the members that have that property.
  • To search for specific values of a property, specify the name and value as <name>:<value>. If <value> contains non-alphanumeric characters (for example, blanks), surround it with double quotes.
  • To search for names or values using wildcards, use * as the wildcard character.
  • You can do range searches using the syntax <name>:[<lower> to <upper>] (The value of <lower> must be less than or equal to <upper>). This works for numeric and alphabetic values.
  • To search for the existence of a property, use _exists_ and _missing_.
  • A single property name and value (or wildcards) make up a predicate that implicitly returns a boolean.
  • Join predicates with the NOT, AND, and OR boolean operators.
  • Use parentheses '(' and ')' to change the evaluation order.
orderBy
string

The member object property on which SignalFx should sort the results. You don't have to include this property in your query, but the value must be a valid organization property.

header Parameters
Content-Type
required
string

Format of the request payload. The only allowed value is 'application/json'

X-SF-Token
required
string

A valid access token.

Responses

200

Successful retrieval of members of an organization

Response Schema: application/json
results
Array of object (MemberObjectArray)

Array of members. Each element contains a single result for the query, in the form of a member object.

count
integer <int32>

The number of member objects in the result set produced by the query.
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.

Response samples

application/json
Copy
Expand all Collapse all
{
  • "results":
    [
    ],
  • "count": 0
}

Invite Member

Invites a user to the organization

post /organization/member

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https://api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/organization/member

Invites a SignalFx user to the organization. To make this request, you must have administrative access for this organization.

header Parameters
Content-Type
required
string

Format of the request payload. The only allowed value is 'application/json'

X-SF-Token
required
string

A valid access token

Request Body schema: application/json
email
required
string

Person's email address. SignalFx sends a special invitation email to this address; this is the only way that the person can join the organization.

fullName
string

Person's full name

title
string

Person's job title

phone
string

Person's telephone number

admin
any

Flag that indicates if the person should be an organization administrator. If true, the person is added as an administrator.

Responses

200

Successful invitation of the user to the organization.

Response Schema: application/json
email
string

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.

fullName
string

Users's full name

title
string

Users's job title

phone
string

Users's telephone number

admin
any

Flag that indicates if the user should get administrative access to the organization. If true, SignalFx gives administrative access after the user joins.

Request samples

application/json
Copy
Expand all Collapse all
{
  • "email": "string",
  • "fullName": "string",
  • "title": "string",
  • "phone": "string",
  • "admin": null
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "email": "string",
  • "fullName": "string",
  • "title": "string",
  • "phone": "string",
  • "admin": null
}

Invite Members

Invites users to the organization

post /organization/members

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https://api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/organization/members

Invites SignalFx users to your organization. To make this request, you must have administrative access to this organization.

header Parameters
Content-Type
required
string

Format of the request payload. The only allowed value is 'application/json'

X-SF-Token
required
string

A valid access token.

Request Body schema: application/json
members
required
Array of Array of object (MemberObjectArray)

Array of member objects for the users you want to invite. Each object must contain the email property.

Responses

200

Successful invitation of the specified people to the organization.

Response Schema: application/json
members
Array of object (Properties of a single organization member)

Array of member objects for the members that the request invited.

Request samples

application/json
Copy
Expand all Collapse all
{
  • "members":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "members":
    [
    ]
}

Retrieve Member Using Member ID

Retrieves the information for the member specified in the {id} path parameter

get /organization/member/{id}

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https://api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/organization/member/{id}

Retrieve the member object for a member of the organization. Specify the member by member ID, using the id path parameter.

path Parameters
id
required
string

The SignalFx-assigned member ID of the member whose information you want to retrieve.

header Parameters
X-SF-Token
required
string

An access token for a user that has authorization to retrieve members of the organization. You don't need administrative access to retrieve the member, and you can use either an org token or a session token.

Responses

200

Successful retrieval of the member information.

Response Schema: application/json
creator
string

SignalFx-assigned ID of the user that created this member

lastUpdatedBy
string

SignalFx-assigned ID of the user that last updated this member

created
integer <int64>

The member creation date and time, in Unix time UTC-relative. The system sets this value, and you can't change it.

lastUpdated
integer <int32>

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.

id
string

SignalFx-assigned ID of the member

userId
string

SignalFx-assigned user ID for this member

organizationId
any

SignalFx-assigned organization ID for the organization that the member belongs to

email
string

Email address for the SignalFx user associated with this member record

fullName
string

Full name of the user associated with this member record

phone
string

Phone number of the user associated with this member record

title
string

Job title of the user associated with this member record

admin
boolean

Administrator status flag. If true, this member has administrative authorization for the organization.

Response samples

application/json
Copy
Expand all Collapse all
{
  • "creator": "string",
  • "lastUpdatedBy": "string",
  • "created": 1533676829319,
  • "lastUpdated": 1557696630000,
  • "id": "string",
  • "userId": "string",
  • "organizationId": null,
  • "email": "string",
  • "fullName": "string",
  • "phone": "string",
  • "title": "string",
  • "admin": true
}

Update Member Admin Access Using ID

Updates the administrative access for the member specified in the {id} path parameter

put /organization/member/{id}

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https://api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/organization/member/{id}

Update the administrative access flag for a member of the organization. Specify the member by member ID, using the id path parameter.

path Parameters
id
required
string

The SignalFx-assigned member ID of the member whose access you want to update.

header Parameters
Content-Type
required
string

Format of the request payload. The only allowed value is 'application/json'

X-SF-Token
required
string

A valid org access token. The SignalFx user for this token must have administrative access for the organization.

Request Body schema: application/json
admin
boolean

Flag that controls a member's administrative access to the organization. If true, the member has administrative access.

Responses

200

Successful update of the member's admin flag.

Response Schema: application/json
creator
string

SignalFx-assigned ID of the user that created this member

lastUpdatedBy
string

SignalFx-assigned ID of the user that last updated this member

created
integer <int64>

The member creation date and time, in Unix time UTC-relative. The system sets this value, and you can't change it.

lastUpdated
integer <int32>

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.

id
string

SignalFx-assigned ID of the member

userId
string

SignalFx-assigned user ID for this member

organizationId
any

SignalFx-assigned organization ID for the organization that the member belongs to

email
string

Email address for the SignalFx user associated with this member record

fullName
string

Full name of the user associated with this member record

phone
string

Phone number of the user associated with this member record

title
string

Job title of the user associated with this member record

admin
boolean

Administrator status flag. If true, this member has administrative authorization for the organization.

Request samples

application/json
Copy
Expand all Collapse all
{
  • "admin": true
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "creator": "string",
  • "lastUpdatedBy": "string",
  • "created": 1533676829319,
  • "lastUpdated": 1557696630000,
  • "id": "string",
  • "userId": "string",
  • "organizationId": null,
  • "email": "string",
  • "fullName": "string",
  • "phone": "string",
  • "title": "string",
  • "admin": true
}

Delete Member Using ID

Deletes the member specified in the {id} path parameter

delete /organization/member/{id}

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https://api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/organization/member/{id}

Deletes a member from the organization. The user retains access to other SignalFx organizations that he or she belongs to.
Specify the member by member ID, using the id path parameter.

path Parameters
id
required
string

The SignalFx-assigned member ID of the member whose access you want to update.

header Parameters
X-SF-Token
required
string

A valid org access token. The SignalFx user for this token must have administrative access for the organization.

Responses

200

Successful deletion of the member from the organization

© Copyright 2019 SignalFx.

Third-party license information