SCIM
Get group by ID via SCIM v2.0
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 by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
- Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
- 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, with the scopes they choose there. See Authorization for customers.
get/v1/scim/v2/Groups/{id}
Request
- Base URLhttps://gateway.remote.com
- URLhttps://gateway.remote.com/v1/scim/v2/Groups/{id}
- Auth
- OAuth 2Authorization code: /auth/oauth2/authorizeToken URL: /auth/oauth2/token
- or OAuth 2Client credentialsToken URL: /auth/oauth2/token
- or OAuth 2Client credentialsToken URL: /auth/oauth2/token
- or HTTP bearer
Path parameters
idstring required
Group ID (slug)
Response
Success
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
No recorded changes to this operation across all 1 revision of this API.