SharedSignalsFrameworkSSFAPI

The SSF Transmitter Service is a security event notification system that monitors identity attribute changes and automatically triggers session revocation events when specific lifecycle conditions are met.

Use this API to implement transmitter functionality so administrators can discover the transmitter and manage streams. Transmitters send identity data and events from Identity Security Cloud to external receivers over the Secure Sync Framework (SSF). The SSF configuration and JWKS endpoints support discovery and verification; the stream management endpoints support creating, updating, and managing streams and verifying receivers. In Identity Security Cloud, administrators can use the "Connections" > "Shared Signals" area to view and manage transmitters and their streams.

All URIs are relative to https://sailpoint.api.identitynow.com

Method	HTTP request	Description
create-stream-v1	Post /ssf/v1/streams	Create stream
delete-stream-v1	Delete /ssf/v1/streams	Delete stream
get-jwks-data-v1	Get /ssf/v1/jwks	Get JWKS
get-ssf-configuration-v1	Get /.well-known/v1/ssf-configuration	Get SSF configuration
get-stream-status-v1	Get /ssf/v1/streams/status	Get stream status
get-stream-v1	Get /ssf/v1/streams	Get stream(s)
send-stream-verification-v1	Post /ssf/v1/streams/verify	Verify stream
set-stream-configuration-v1	Put /ssf/v1/streams	Replace stream configuration
update-stream-configuration-v1	Patch /ssf/v1/streams	Update stream configuration
update-stream-status-v1	Post /ssf/v1/streams/status	Update stream status

create-stream-v1

Create stream An SSF stream is associated with the client ID of the OAuth 2.0 access token used to create the stream. One SSF stream is allowed for each client ID.

You can create a maximum of 10 SSF stream configurations for one org.

API Spec

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCreateStreamV1Request struct via the builder pattern

Name	Type	Description	Notes
createstreamrequest	Createstreamrequest

Return type

Streamconfigresponse

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

package main

import (
	"context"
	"fmt"
	"os"
  "encoding/json"
    v1 "github.com/sailpoint-oss/golang-sdk/v3/shared_signals_framework_ssf"
	sailpoint "github.com/sailpoint-oss/golang-sdk/v3/shared_signals_framework_ssf"
)

func main() {
    createstreamrequest := []byte(`{"delivery":{"method":"urn:ietf:rfc:8935","endpoint_url":"https://receiver.example.com/ssf/events"},"events_requested":["https://schemas.openid.net/secevent/caep/event-type/session-revoked"],"description":"Production event stream for session revocation notifications"}`) // Createstreamrequest | 

    var createstreamrequest v1.Createstreamrequest
    if err := json.Unmarshal(createstreamrequest, &createstreamrequest); err != nil {
      fmt.Println("Error:", err)
      return
    }
    

    configuration := sailpoint.NewDefaultConfiguration()
    apiClient := sailpoint.NewAPIClient(configuration)
    resp, r, err := apiClient.SharedSignalsFrameworkSSFAPI.CreateStreamV1(context.Background()).Createstreamrequest(createstreamrequest).Execute()
	  //resp, r, err := apiClient.SharedSignalsFrameworkSSFAPI.CreateStreamV1(context.Background()).Createstreamrequest(createstreamrequest).Execute()
    if err != nil {
	    fmt.Fprintf(os.Stderr, "Error when calling `SharedSignalsFrameworkSSFAPI.CreateStreamV1``: %v\n", err)
	    fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateStreamV1`: Streamconfigresponse
    fmt.Fprintf(os.Stdout, "Response from `SharedSignalsFrameworkSSFAPI.CreateStreamV1`: %v\n", resp)
}

[Back to top]

delete-stream-v1

Delete stream Deletes a stream by its ID. There is no request body; the stream is identified by the required query parameter stream_id. On success the response has no body (204 No Content).

The associated stream with the client ID (through the request OAuth 2.0 access token) is deleted.

API Spec

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiDeleteStreamV1Request struct via the builder pattern

Name	Type	Description	Notes
streamId	string	ID of the stream to delete. Required; omitted or empty returns 400.

Return type

(empty response body)

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

package main

import (
	"context"
	"fmt"
	"os"
  
    
	sailpoint "github.com/sailpoint-oss/golang-sdk/v3/shared_signals_framework_ssf"
)

func main() {
    streamId := `550e8400-e29b-41d4-a716-446655440000` // string | ID of the stream to delete. Required; omitted or empty returns 400. # string | ID of the stream to delete. Required; omitted or empty returns 400.

    

    configuration := sailpoint.NewDefaultConfiguration()
    apiClient := sailpoint.NewAPIClient(configuration)
    r, err := apiClient.SharedSignalsFrameworkSSFAPI.DeleteStreamV1(context.Background()).StreamId(streamId).Execute()
	  //r, err := apiClient.SharedSignalsFrameworkSSFAPI.DeleteStreamV1(context.Background()).StreamId(streamId).Execute()
    if err != nil {
	    fmt.Fprintf(os.Stderr, "Error when calling `SharedSignalsFrameworkSSFAPI.DeleteStreamV1``: %v\n", err)
	    fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    
}

[Back to top]

get-jwks-data-v1

Get JWKS Returns the transmitter's JSON Web Key Set (JWKS) for verifying signed delivery requests.

API Spec

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetJWKSDataV1Request struct via the builder pattern

Return type

Jwks

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

package main

import (
	"context"
	"fmt"
	"os"
  
    
	sailpoint "github.com/sailpoint-oss/golang-sdk/v3/shared_signals_framework_ssf"
)

func main() {

    

    configuration := sailpoint.NewDefaultConfiguration()
    apiClient := sailpoint.NewAPIClient(configuration)
    resp, r, err := apiClient.SharedSignalsFrameworkSSFAPI.GetJWKSDataV1(context.Background()).Execute()
	  //resp, r, err := apiClient.SharedSignalsFrameworkSSFAPI.GetJWKSDataV1(context.Background()).Execute()
    if err != nil {
	    fmt.Fprintf(os.Stderr, "Error when calling `SharedSignalsFrameworkSSFAPI.GetJWKSDataV1``: %v\n", err)
	    fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetJWKSDataV1`: Jwks
    fmt.Fprintf(os.Stdout, "Response from `SharedSignalsFrameworkSSFAPI.GetJWKSDataV1`: %v\n", resp)
}

[Back to top]

get-ssf-configuration-v1

Get SSF configuration Returns the SSF transmitter discovery metadata (well-known configuration).

API Spec

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetSSFConfigurationV1Request struct via the builder pattern

Return type

Transmittermetadata

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

package main

import (
	"context"
	"fmt"
	"os"
  
    
	sailpoint "github.com/sailpoint-oss/golang-sdk/v3/shared_signals_framework_ssf"
)

func main() {

    

    configuration := sailpoint.NewDefaultConfiguration()
    apiClient := sailpoint.NewAPIClient(configuration)
    resp, r, err := apiClient.SharedSignalsFrameworkSSFAPI.GetSSFConfigurationV1(context.Background()).Execute()
	  //resp, r, err := apiClient.SharedSignalsFrameworkSSFAPI.GetSSFConfigurationV1(context.Background()).Execute()
    if err != nil {
	    fmt.Fprintf(os.Stderr, "Error when calling `SharedSignalsFrameworkSSFAPI.GetSSFConfigurationV1``: %v\n", err)
	    fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetSSFConfigurationV1`: Transmittermetadata
    fmt.Fprintf(os.Stdout, "Response from `SharedSignalsFrameworkSSFAPI.GetSSFConfigurationV1`: %v\n", resp)
}

[Back to top]

get-stream-status-v1

Get stream status Returns the status (enabled, paused, disabled) and optional reason for the stream associated with the client ID of the request's OAuth 2.0 access token. The stream_id query parameter is required.

API Spec

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetStreamStatusV1Request struct via the builder pattern

Name	Type	Description	Notes
streamId	string	ID of the stream whose status to retrieve.

Return type

Streamstatusresponse

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

package main

import (
	"context"
	"fmt"
	"os"
  
    
	sailpoint "github.com/sailpoint-oss/golang-sdk/v3/shared_signals_framework_ssf"
)

func main() {
    streamId := `550e8400-e29b-41d4-a716-446655440000` // string | ID of the stream whose status to retrieve. # string | ID of the stream whose status to retrieve.

    

    configuration := sailpoint.NewDefaultConfiguration()
    apiClient := sailpoint.NewAPIClient(configuration)
    resp, r, err := apiClient.SharedSignalsFrameworkSSFAPI.GetStreamStatusV1(context.Background()).StreamId(streamId).Execute()
	  //resp, r, err := apiClient.SharedSignalsFrameworkSSFAPI.GetStreamStatusV1(context.Background()).StreamId(streamId).Execute()
    if err != nil {
	    fmt.Fprintf(os.Stderr, "Error when calling `SharedSignalsFrameworkSSFAPI.GetStreamStatusV1``: %v\n", err)
	    fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetStreamStatusV1`: Streamstatusresponse
    fmt.Fprintf(os.Stdout, "Response from `SharedSignalsFrameworkSSFAPI.GetStreamStatusV1`: %v\n", resp)
}

[Back to top]

get-stream-v1

Get stream(s) Retrieves either a list of all SSF stream configurations or the individual configuration if specified by ID.

As stream configurations are tied to a client ID, you can only view the stream associated with the client ID of the request OAuth 2.0 access token.

Query parameter aud (co filter) can be used to filter by audience.

API Spec

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetStreamV1Request struct via the builder pattern

Name	Type	Description	Notes
streamId	string	If provided, returns that stream; otherwise returns list of all streams.

Return type

GetStreamV1200Response

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

package main

import (
	"context"
	"fmt"
	"os"
  
    
	sailpoint "github.com/sailpoint-oss/golang-sdk/v3/shared_signals_framework_ssf"
)

func main() {
    streamId := `550e8400-e29b-41d4-a716-446655440000` // string | If provided, returns that stream; otherwise returns list of all streams. (optional) # string | If provided, returns that stream; otherwise returns list of all streams. (optional)

    

    configuration := sailpoint.NewDefaultConfiguration()
    apiClient := sailpoint.NewAPIClient(configuration)
    resp, r, err := apiClient.SharedSignalsFrameworkSSFAPI.GetStreamV1(context.Background()).Execute()
	  //resp, r, err := apiClient.SharedSignalsFrameworkSSFAPI.GetStreamV1(context.Background()).StreamId(streamId).Execute()
    if err != nil {
	    fmt.Fprintf(os.Stderr, "Error when calling `SharedSignalsFrameworkSSFAPI.GetStreamV1``: %v\n", err)
	    fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetStreamV1`: GetStreamV1200Response
    fmt.Fprintf(os.Stdout, "Response from `SharedSignalsFrameworkSSFAPI.GetStreamV1`: %v\n", resp)
}

[Back to top]

send-stream-verification-v1

Verify stream Verifies an SSF stream by publishing a verification event requested by a security events provider.

API Spec

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiSendStreamVerificationV1Request struct via the builder pattern

Name	Type	Description	Notes
verificationrequest	Verificationrequest

Return type

(empty response body)

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

package main

import (
	"context"
	"fmt"
	"os"
  "encoding/json"
    v1 "github.com/sailpoint-oss/golang-sdk/v3/shared_signals_framework_ssf"
	sailpoint "github.com/sailpoint-oss/golang-sdk/v3/shared_signals_framework_ssf"
)

func main() {
    verificationrequest := []byte(`{"stream_id":"550e8400-e29b-41d4-a716-446655440000","state":"verification-challenge-state-123"}`) // Verificationrequest | 

    var verificationrequest v1.Verificationrequest
    if err := json.Unmarshal(verificationrequest, &verificationrequest); err != nil {
      fmt.Println("Error:", err)
      return
    }
    

    configuration := sailpoint.NewDefaultConfiguration()
    apiClient := sailpoint.NewAPIClient(configuration)
    r, err := apiClient.SharedSignalsFrameworkSSFAPI.SendStreamVerificationV1(context.Background()).Verificationrequest(verificationrequest).Execute()
	  //r, err := apiClient.SharedSignalsFrameworkSSFAPI.SendStreamVerificationV1(context.Background()).Verificationrequest(verificationrequest).Execute()
    if err != nil {
	    fmt.Fprintf(os.Stderr, "Error when calling `SharedSignalsFrameworkSSFAPI.SendStreamVerificationV1``: %v\n", err)
	    fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    
}

[Back to top]

set-stream-configuration-v1

Replace stream configuration Replaces a stream's configuration (PUT). stream_id and delivery are required; full receiver-supplied properties.

The associated stream with the client ID (through the request OAuth 2.0 access token) is replaced.

API Spec

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiSetStreamConfigurationV1Request struct via the builder pattern

Name	Type	Description	Notes
replacestreamconfigurationrequest	Replacestreamconfigurationrequest

Return type

Updatestreamconfigresponse

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

package main

import (
	"context"
	"fmt"
	"os"
  "encoding/json"
    v1 "github.com/sailpoint-oss/golang-sdk/v3/shared_signals_framework_ssf"
	sailpoint "github.com/sailpoint-oss/golang-sdk/v3/shared_signals_framework_ssf"
)

func main() {
    replacestreamconfigurationrequest := []byte(`{"stream_id":"550e8400-e29b-41d4-a716-446655440000","delivery":{"method":"urn:ietf:rfc:8935","endpoint_url":"https://receiver.example.com/ssf/events"},"events_requested":["https://schemas.openid.net/secevent/caep/event-type/session-revoked"],"description":"Replaced stream configuration for production event delivery"}`) // Replacestreamconfigurationrequest | 

    var replacestreamconfigurationrequest v1.Replacestreamconfigurationrequest
    if err := json.Unmarshal(replacestreamconfigurationrequest, &replacestreamconfigurationrequest); err != nil {
      fmt.Println("Error:", err)
      return
    }
    

    configuration := sailpoint.NewDefaultConfiguration()
    apiClient := sailpoint.NewAPIClient(configuration)
    resp, r, err := apiClient.SharedSignalsFrameworkSSFAPI.SetStreamConfigurationV1(context.Background()).Replacestreamconfigurationrequest(replacestreamconfigurationrequest).Execute()
	  //resp, r, err := apiClient.SharedSignalsFrameworkSSFAPI.SetStreamConfigurationV1(context.Background()).Replacestreamconfigurationrequest(replacestreamconfigurationrequest).Execute()
    if err != nil {
	    fmt.Fprintf(os.Stderr, "Error when calling `SharedSignalsFrameworkSSFAPI.SetStreamConfigurationV1``: %v\n", err)
	    fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `SetStreamConfigurationV1`: Updatestreamconfigresponse
    fmt.Fprintf(os.Stdout, "Response from `SharedSignalsFrameworkSSFAPI.SetStreamConfigurationV1`: %v\n", resp)
}

[Back to top]

update-stream-configuration-v1

Update stream configuration Partially updates a stream's configuration (PATCH). Only provided fields are updated.

The associated stream with the client ID (through the request OAuth 2.0 access token) is updated.

API Spec

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiUpdateStreamConfigurationV1Request struct via the builder pattern

Name	Type	Description	Notes
updatestreamconfigurationrequest	Updatestreamconfigurationrequest

Return type

Updatestreamconfigresponse

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

package main

import (
	"context"
	"fmt"
	"os"
  "encoding/json"
    v1 "github.com/sailpoint-oss/golang-sdk/v3/shared_signals_framework_ssf"
	sailpoint "github.com/sailpoint-oss/golang-sdk/v3/shared_signals_framework_ssf"
)

func main() {
    updatestreamconfigurationrequest := []byte(`{"stream_id":"550e8400-e29b-41d4-a716-446655440000","description":"Updated production event stream configuration"}`) // Updatestreamconfigurationrequest | 

    var updatestreamconfigurationrequest v1.Updatestreamconfigurationrequest
    if err := json.Unmarshal(updatestreamconfigurationrequest, &updatestreamconfigurationrequest); err != nil {
      fmt.Println("Error:", err)
      return
    }
    

    configuration := sailpoint.NewDefaultConfiguration()
    apiClient := sailpoint.NewAPIClient(configuration)
    resp, r, err := apiClient.SharedSignalsFrameworkSSFAPI.UpdateStreamConfigurationV1(context.Background()).Updatestreamconfigurationrequest(updatestreamconfigurationrequest).Execute()
	  //resp, r, err := apiClient.SharedSignalsFrameworkSSFAPI.UpdateStreamConfigurationV1(context.Background()).Updatestreamconfigurationrequest(updatestreamconfigurationrequest).Execute()
    if err != nil {
	    fmt.Fprintf(os.Stderr, "Error when calling `SharedSignalsFrameworkSSFAPI.UpdateStreamConfigurationV1``: %v\n", err)
	    fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateStreamConfigurationV1`: Updatestreamconfigresponse
    fmt.Fprintf(os.Stdout, "Response from `SharedSignalsFrameworkSSFAPI.UpdateStreamConfigurationV1`: %v\n", resp)
}

[Back to top]

update-stream-status-v1

Update stream status Updates the operational status (enabled, paused, disabled) with an optional reason for the stream associated with the client ID of the request's OAuth 2.0 access token.

API Spec

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiUpdateStreamStatusV1Request struct via the builder pattern

Name	Type	Description	Notes
updatestreamstatusrequest	Updatestreamstatusrequest

Return type

Streamstatusresponse

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

package main

import (
	"context"
	"fmt"
	"os"
  "encoding/json"
    v1 "github.com/sailpoint-oss/golang-sdk/v3/shared_signals_framework_ssf"
	sailpoint "github.com/sailpoint-oss/golang-sdk/v3/shared_signals_framework_ssf"
)

func main() {
    updatestreamstatusrequest := []byte(`{"stream_id":"550e8400-e29b-41d4-a716-446655440000","status":"paused","reason":"manually paused"}`) // Updatestreamstatusrequest | 

    var updatestreamstatusrequest v1.Updatestreamstatusrequest
    if err := json.Unmarshal(updatestreamstatusrequest, &updatestreamstatusrequest); err != nil {
      fmt.Println("Error:", err)
      return
    }
    

    configuration := sailpoint.NewDefaultConfiguration()
    apiClient := sailpoint.NewAPIClient(configuration)
    resp, r, err := apiClient.SharedSignalsFrameworkSSFAPI.UpdateStreamStatusV1(context.Background()).Updatestreamstatusrequest(updatestreamstatusrequest).Execute()
	  //resp, r, err := apiClient.SharedSignalsFrameworkSSFAPI.UpdateStreamStatusV1(context.Background()).Updatestreamstatusrequest(updatestreamstatusrequest).Execute()
    if err != nil {
	    fmt.Fprintf(os.Stderr, "Error when calling `SharedSignalsFrameworkSSFAPI.UpdateStreamStatusV1``: %v\n", err)
	    fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateStreamStatusV1`: Streamstatusresponse
    fmt.Fprintf(os.Stdout, "Response from `SharedSignalsFrameworkSSFAPI.UpdateStreamStatusV1`: %v\n", resp)
}

[Back to top]