SignalFx Developers Guide

Organizations and Teams

Organizations represent all of the aspects of your SignalFx account. Teams are a way to group together some members of an organization.

Organizations

All users belong to an organization, and may also belong to one or more teams. The users that belong to an organization are its members; in most cases, users are members of a single organization that they think of as their "SignalFx account".

Evey SignalFx user has a user ID that’s unique across all organizations. Members of an organization also have a user ID that’s specific to that organization.

Users can’t add themselves to an organization. Instead, they need an invitation from a member that has administrative access to the organization. After users join an organization, they can do the following:

  • Submit datapoints to the organization

  • Use the SignalFx web UI to look at organization features

  • Use the SignalFx API to work with organization features

Teams

A team is a list of SignalFx users.

Teams link their members to dashboard groups and detectors. SignalFx stores the link information with the internal team object.

Teams also serve as alert notification targets.

Team notification policy

A team’s notification policy is a list of notification services.

When you specify Team as the notification type for an alerting rule or org token threshold, SignalFx sends an alert to all the notification services in the list.

To learn more, see Team notifications.

Team management

To manage a team or teams, use the following operations; to learn more, see the Teams API reference.

  • Create a team :

    POST https://api.{REALM}.signalfx.com/v2/team

  • Retrieve a team by team ID :

    GET https://api.{REALM}.signalfx.com/v2/team/{id}

  • Retrieve a team using a query :

    GET https://api.{REALM}.signalfx.com/v2/team

  • Retrieve a team member for a team :

    GET https://api.{REALM}.signalfx.com/team/{id}/member/{orgUserId}

  • Update a team :

    PUT https://api.{REALM}.signalfx.com/v2/team/{id}

  • Update the team manager flag for a user :

    PUT https://api.{REALM}.signalfx.com/v2/team/{id}/membership

  • Update team manager flags for users :

    PUT https://api.{REALM}.signalfx.com/v2/team/{id}/memberships

  • Retrieve a team by team ID

    GET https://api.{REALM}.signalfx.com/v2/team/{id}/member/{orgUserId}

  • Delete a team :

    DELETE https://api.{REALM}.signalfx.com/v2/team/{id}

To manage dashboard group and detector links, team members can use the following operations:

Team notifications

To send event notifications to a team or teams, use the /detectors_reference.html[Detectors API]:

In the Detectors API operations that let you set notifications, specify the following:

  • Team or TeamEmail as the value of rules[<rule_index>].notifications[<notification_index>].type.

  • The SignalFx-assigned team ID as the value of rules[<rule_index>].notifications[<notification_index>].team`.

The value of type has these effects:

  • Team: Sends notifications according to the specified teams notification policy.

  • TeamEmail: Sends email notifications to all the members of the team. SignalFx uses the email in the user’s profile.

In addition, teams can be notification targets for detectors, so that some or all team members see alerts and other notification destinations of interest to them. To set a team as a notification target, use a notification of type "Team". You can also send a notification email to one or more teams using a notification of type "TeamEmail".

© Copyright 2020 Splunk, Inc.

Third-party license information