---
updatedAt: 2026-06-03T19:55:39.000Z
agentTools:
  projectIndex: https://developers.tackle.io/llms.txt
---

# Get Groups

Retrieve available groups (roles) for the organization.
This is the standard SCIM 2.0 Groups endpoint per RFC 7644.
It fetches roles from the RBAC service and returns them as SCIM Group resources
with meta.resourceType set to "Group", as required by identity providers (Okta, Azure AD).


# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "SCIM API",
    "description": "A SCIM (System for Cross-domain Identity Management) 2.0 compliant API for managing users\nthrough Auth0. This API provides endpoints for user management operations following RFC 7644.\n\nThe API supports:\n- User CRUD operations (Create, Read, Update, List)\n- SCIM 2.0 compliant error responses\n- Bearer token authentication\n- Enterprise user extensions\n",
    "version": "2.0.0",
    "contact": {
      "name": "Tackle.io"
    },
    "license": {
      "name": "Proprietary"
    }
  },
  "servers": [
    {
      "url": "https://scim.tackle.io",
      "description": "SCIM API Server",
      "variables": {
        "domain": {
          "default": "scim-api.tackle.io",
          "description": "The domain for the SCIM API"
        }
      }
    }
  ],
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "paths": {
    "/scim/v2/Groups": {
      "get": {
        "tags": [
          "Groups"
        ],
        "summary": "Get Groups",
        "description": "Retrieve available groups (roles) for the organization.\nThis is the standard SCIM 2.0 Groups endpoint per RFC 7644.\nIt fetches roles from the RBAC service and returns them as SCIM Group resources\nwith meta.resourceType set to \"Group\", as required by identity providers (Okta, Azure AD).\n",
        "operationId": "getGroups",
        "responses": {
          "200": {
            "description": "Groups retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GroupListResponse"
                },
                "example": {
                  "schemas": [
                    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
                  ],
                  "totalResults": 3,
                  "startIndex": 1,
                  "itemsPerPage": 3,
                  "Resources": [
                    {
                      "schemas": [
                        "urn:ietf:params:scim:schemas:core:2.0:Group"
                      ],
                      "id": "role_admin_123",
                      "displayName": "Administrator",
                      "meta": {
                        "resourceType": "Group",
                        "location": "https://scim-api.tackle.io/scim/v2/Groups/role_admin_123"
                      },
                      "members": []
                    },
                    {
                      "schemas": [
                        "urn:ietf:params:scim:schemas:core:2.0:Group"
                      ],
                      "id": "role_user_456",
                      "displayName": "User",
                      "meta": {
                        "resourceType": "Group",
                        "location": "https://scim-api.tackle.io/scim/v2/Groups/role_user_456"
                      },
                      "members": []
                    },
                    {
                      "schemas": [
                        "urn:ietf:params:scim:schemas:core:2.0:Group"
                      ],
                      "id": "role_viewer_789",
                      "displayName": "Viewer",
                      "meta": {
                        "resourceType": "Group",
                        "location": "https://scim-api.tackle.io/scim/v2/Groups/role_viewer_789"
                      },
                      "members": []
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "description": "API key authentication.\nInclude the API key in the Authorization header.\n"
      }
    },
    "responses": {
      "Unauthorized": {
        "description": "Authentication information is missing or invalid",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ScimError"
            },
            "example": {
              "schemas": [
                "urn:ietf:params:scim:api:messages:2.0:Error"
              ],
              "status": "401",
              "detail": "Unauthorized"
            }
          }
        }
      },
      "Forbidden": {
        "description": "Access forbidden",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ScimError"
            },
            "example": {
              "schemas": [
                "urn:ietf:params:scim:api:messages:2.0:Error"
              ],
              "status": "403",
              "detail": "Forbidden"
            }
          }
        }
      },
      "InternalServerError": {
        "description": "Internal server error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ScimError"
            },
            "example": {
              "schemas": [
                "urn:ietf:params:scim:api:messages:2.0:Error"
              ],
              "status": "500",
              "detail": "Internal server error"
            }
          }
        }
      }
    },
    "schemas": {
      "Group": {
        "type": "object",
        "required": [
          "schemas",
          "id",
          "displayName",
          "meta",
          "members"
        ],
        "properties": {
          "schemas": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "urn:ietf:params:scim:schemas:core:2.0:Group"
            ]
          },
          "id": {
            "type": "string",
            "description": "The unique identifier of the group (role ID)",
            "example": "role_admin_123"
          },
          "displayName": {
            "type": "string",
            "description": "The display name of the group (role name)",
            "example": "Administrator"
          },
          "meta": {
            "type": "object",
            "required": [
              "resourceType",
              "location"
            ],
            "properties": {
              "resourceType": {
                "type": "string",
                "description": "Always \"Group\" for this resource type",
                "example": "Group"
              },
              "location": {
                "type": "string",
                "format": "uri",
                "description": "URL to this group resource",
                "example": "https://scim-api.tackle.io/scim/v2/Groups/role_admin_123"
              }
            }
          },
          "members": {
            "type": "array",
            "description": "Group members (always empty; membership is managed via user entitlements)",
            "items": {
              "type": "string"
            },
            "example": []
          }
        }
      },
      "GroupListResponse": {
        "type": "object",
        "required": [
          "schemas",
          "totalResults",
          "startIndex",
          "itemsPerPage",
          "Resources"
        ],
        "properties": {
          "schemas": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "urn:ietf:params:scim:api:messages:2.0:ListResponse"
            ]
          },
          "totalResults": {
            "type": "integer",
            "description": "Total number of groups",
            "example": 3
          },
          "startIndex": {
            "type": "integer",
            "description": "1-based index of the first result",
            "example": 1
          },
          "itemsPerPage": {
            "type": "integer",
            "description": "Number of groups in this response",
            "example": 3
          },
          "Resources": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Group"
            }
          }
        }
      },
      "ScimError": {
        "type": "object",
        "required": [
          "schemas",
          "status",
          "detail"
        ],
        "properties": {
          "schemas": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "urn:ietf:params:scim:api:messages:2.0:Error"
            ]
          },
          "status": {
            "type": "string",
            "description": "HTTP status code as string",
            "example": "400"
          },
          "detail": {
            "type": "string",
            "description": "Human-readable error description",
            "example": "Invalid request"
          },
          "scimType": {
            "type": "string",
            "description": "SCIM-specific error type",
            "enum": [
              "invalidFilter",
              "tooMany",
              "uniqueness",
              "mutability",
              "invalidSyntax",
              "invalidPath",
              "noTarget",
              "invalidValue",
              "invalidVers",
              "sensitive"
            ],
            "example": "invalidValue"
          }
        }
      }
    }
  },
  "tags": [
    {
      "name": "Groups",
      "description": "SCIM 2.0 Groups endpoint - returns full Group resources (RFC 7643 §4.2)"
    }
  ],
  "externalDocs": {
    "description": "SCIM 2.0 RFC 7644 Specification",
    "url": "https://datatracker.ietf.org/doc/html/rfc7644"
  }
}
```