Skip to main content
GET
/
v1
/
b2b
/
scim
/
{organization_id}
/
connection
/
{connection_id}
C#
// GET /v1/b2b/scim/{organization_id}/connection/{connection_id}
const stytch = require('stytch');

const client = new stytch.B2BClient({
  project_id: '${projectId}',
  secret: '${secret}',
});

const params = {
  organization_id: "${organizationId}",
  connection_id: "${scimConnectionId}",
};

const options = {
  authorization: {
    session_token: '${sessionToken}',
  },
};

client.SCIM.Connection.GetGroups(params, options)
  .then(resp => { console.log(resp) })
  .catch(err => { console.log(err) });
{
  "scim_groups": [
    {
      "group_id": "<string>",
      "group_name": "<string>",
      "organization_id": "<string>",
      "connection_id": "<string>"
    }
  ],
  "status_code": 123,
  "next_cursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

​
X-Stytch-Member-Session
string

A Stytch session that can be used to run the request with the given member's permissions.

​
X-Stytch-Member-SessionJWT
string

A Stytch Session JSON Web Token (JWT) that can be used to run the request with the given member's permissions.

Path Parameters

​
organization_id
string
required

Globally unique UUID that identifies a specific Organization. The organization_id is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.

​
connection_id
string
required

The ID of the SCIM connection.

Query Parameters

​
cursor
string

The cursor field allows you to paginate through your results. Each result array is limited to 1000 results. If your query returns more than 1000 results, you will need to paginate the responses using the cursor. If you receive a response that includes a non-null next_cursor in the results_metadata object, repeat the search call with the next_cursor value set to the cursor field to retrieve the next page of results. Continue to make search calls until the next_cursor in the response is null.

​
limit
integer<int32>

The number of search results to return per page. The default limit is 100. A maximum of 1000 results can be returned by a single search request. If the total size of your result set is greater than one page size, you must paginate the response. See the cursor field.

Required range: x >= 0

Response

Successful response

​
scim_groups
object[]
required

A list of SCIM Connection Groups belonging to the connection.

​
status_code
integer<int32>
required
​
next_cursor
string

The next_cursor string is returned when your search result contains more than one page of results. This value is passed into your next search call in the cursor field.