Integrations
SCIM

Get group by ID via SCIM v2.0

Changed on

Retrieves a single group (department) for the authenticated company by group ID

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Client credentials access token (OAuth2ClientCredentials) — obtained through the Client Credentials flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.
get/v1/scim/v2/Groups/{id}

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/scim/v2/Groups/{id}
  • Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token) and OAuth 2 (client credentials, token URL /auth/oauth2/token)

Path parameters

idstring required

Group ID (slug)

Response

Success

displayNamestring required

Display name of the group

idstring required

Unique identifier for the group

schemasstring[] required

SCIM schema identifiers

Example response

{
  "displayName": "Engineering",
  "id": "engineering-dept",
  "members": [
    {
      "display": "John Doe",
      "value": "user-123-slug"
    }
  ],
  "meta": {
    "created": "2024-01-01T00:00:00Z",
    "lastModified": "2024-01-01T00:00:00Z",
    "resourceType": "Group"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ]
}

Changes

  • 35ec3dcd7e49Revision changes
    • info

      the endpoint scheme security CustomerAPIToken AND OAuth2AuthorizationCode AND OAuth2ClientCredentials was added to the API