Skip to content

Managing Receivers

A receiver is a security vendor that receives and acts on events. Receivers in Identity Security Cloud can configure which subjects they are interested in and how they would like to receive events.

Creating a Receiver

Configure receivers in Identity Security Cloud to receive event data from a transmitter. This allows admins to view event data received through this connection stream.

To create a receiver:

  1. Go to Admin > Connection > Shared Signals.

  2. Select Continue on the Receiver Streams card.

  3. Select Create New.

  4. Enter an SSF Receiver Name.

  5. Enter a Description for the receiver.

  6. Select Save.

The receiver has been created. You can select the Exit icon to go back to the receivers list or continue configuring Connection or the Subject ID for the receiver by selecting the tabs.

Configuring the Connection

Configure a secure connection between the transmitter and SailPoint Receiver by choosing the appropriate authentication.

The authentication options are:

  • API Token

  • OAuth 2.0

Configuring the Connection Using an API Token

  1. Go to Admin > Connection > Shared Signals.

  2. Select Continue on the Receiver Streams card.

  3. Select the receiver you want to configure.

  4. Select the Connection Settings tab to configure the settings for the receiver.

  5. Select API Token from the Authentication Type dropdown.

  6. Enter the API Token to connect to the transmitter.

  7. Enter the Discovery URL of the transmitter to discover and connect to the event stream.

  8. Select one or more Event Type that the receiver should receive from the transmitter.

  9. Select Save.

Configuring the Connection Using OAuth 2.0

  1. Go to Admin > Connection > Shared Signals.

  2. Select Continue on the Receiver Streams card.

  3. Select the receiver you want to configure.

  4. Select the Connection Settings tab to configure the settings for the receiver.

  5. Select OAuth 2.0 from the Authentication Type dropdown.

  6. Select the Grant Type for authentication when connecting to the transmitter. Choose between Client Credentials and JWT Client Credentials.

  7. Enter the Token URL used to obtain an access token from the transmitter authentication server.

  8. If you selected Client Credentials in the Grant Type field:

    • Enter the Client ID and Client Secret.

    • Enter the OAuth Headers. Select Add to add additional headers.

    • Enter the OAuth Request Parameters. Select Add to enter additional parameters.

  9. If you selected JWT Client Credentials in the Grant Type field:

    • Enter the Private Key and Private Key Password.

    • Enter the key-value pairs for the Audience, Issuer, and Subject in the JWT Payload section. Refer to the table below for more information on how to do this. Select Add to enter additional payloads.

    • Enter the algorithm and type used for signing the JWT assertion in the JWT Headers field. Use the key alg and enter the type for the value. Select Add to enter additional headers.

    • Enter the scopes that must be included when creating the JWT token in the OAuth Request Parameters field. Use the key scope and enter space-separated scopes for the value. Select Add to enter additional parameters.

  10. Enter the Discovery URL of the transmitter to discover and connect to the event stream.

  11. Select one or more Event Type for the receiver to receive from the transmitter.

  12. Select Save.

JWT Payload Key-Value Pairs

Key Description Example
aud JWT Audience – Set to your OAuth 2.0 Token URL. Token URL
iss JWT Issuer – Must be the same as the Client ID of your Okta application. Client ID
sub JWT Subject – must be the same as the Client ID of your Okta application. Client ID

Configuring the Subject ID

Shared Signals Framework transmitters send events that include a unique identifier for the subject of the event. This subject ID is used to correlate events to a specific user.

By default, SailPoint receivers expect the subject ID to be the email attribute. If you want to connect to a transmitter that uses the iss_sub format, you can select a source to use the account ID from that source as the subject ID.

To customize the attribute used for the subject ID:

  1. Go to Admin > Connections > Shared Signals.

  2. Select Continue under Receiving Streams.

  3. Select the Actions icon beside the stream you want to update and select Edit.

  4. Select Subject ID Format.

  5. Select Use the account ID from a source.

  6. Select a source.

    This receiver will expect events coming from the associated transmitter to use the attribute marked as the account ID of this source as the subject ID of the event. The subject ID will be used to correlate the event to the correct user.

  7. Select Save.

Managing Receivers

To view your configured receivers, go to Admin > Connections > Shared Signals to open the Receiver Streams page.

Use the buttons at the top to filter which receivers to view by status. Choose between Enabled, Disabled, or Paused to view receivers with only the selected status, or choose All to view all receivers.

Use the search bar to search for receivers by name.

Select the Actions icon to edit or delete a receiver, or to verify the stream.

Select a receiver to view details and the event log for that receiver.

Viewing Details

Selecting a receiver opens the Receiver Stream Details page. View event data associated with the selected receiver as well as details about the receiver.

From the Details tab, you can select a Date Range to see how many events occurred in the selected range. Choose between the last 1, 7, or 30 days. Event data will refresh based on the selected date range.

Viewing Events

From the Event Log tab, all events logged for that receiver along with the status of the event are displayed. You can search for events by keywords used in the Events Summary field.

Filter events by Event Type, Event Date, and Status.

To filter events:

  1. Select the Filter icon to filter the events.

    • Select an Event Type. You can make one or more selections.

    • Select an Event Date. You can make one or more selections.

    • Select a Status. You can make one or more selections.

  2. Select Apply to view your results.

  3. Select Clear Filters to clear all selections and start over.

Select the Actions icon to view the JSON of the event summary.

Documentation Feedback

Feedback is provided as an informational resource only and does not form part of SailPoint’s official product documentation. SailPoint does not warrant or make any guarantees about the feedback (including without limitation as to its accuracy, relevance, or reliability). All feedback is subject to the terms set forth at https://developer.sailpoint.com/discuss/tos.