Auth0

Auth0 groups API

The groups API from Auth0 — 3 operation(s) for groups.

Documentation GitHub OpenAPI

Operations 4

GET /groups Get All Groups #

GET /groups/{id} Get a Group #

DELETE /groups/{id} Delete a Group #

GET /groups/{id}/members Get Group Members #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/auth0-groups-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Auth0 Management Groups API
  description: Auth0 Management API v2.
  termsOfService: https://auth0.com/web-terms/
  contact:
    name: Auth0 Support
    url: https://support.auth0.com
  version: '2.0'
servers:
- url: https://{tenantDomain}/api/v2
  variables:
    tenantDomain:
      default: '{TENANT}.auth0.com'
      description: Auth0 Tenant Domain
security:
- bearerAuth: []
tags:
- name: groups
paths:
  /groups:
    get:
      summary: Get All Groups
      description: 'List all groups in your tenant.

        '
      tags:
      - groups
      parameters:
      - name: connection_id
        in: query
        description: Filter groups by connection ID.
        schema:
          type: string
      - name: name
        in: query
        description: Filter groups by name.
        schema:
          type: string
          minLength: 1
          maxLength: 128
          pattern: ^[\x20-\x7E]+$
      - name: external_id
        in: query
        description: Filter groups by external ID.
        schema:
          type: string
          maxLength: 256
      - name: search
        in: query
        description: Search for groups by name or external ID.
        schema:
          type: string
          minLength: 1
          maxLength: 256
      - name: fields
        in: query
        description: A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields
        schema:
          type: string
          maxLength: 256
          pattern: ^((id)|(name)|(external_id)|(organization_id)|(connection_id)|(tenant_name)|(description)|(created_at)|(updated_at))(,((id)|(name)|(external_id)|(organization_id)|(connection_id)|(tenant_name)|(description)|(created_at)|(updated_at)))*$
      - name: include_fields
        in: query
        description: Whether specified fields are to be included (true) or excluded (false).
        schema:
          type: boolean
      - name: page
        in: query
        description: Page index of the results to return. First page is 0.
        schema:
          type: integer
          minimum: 0
      - name: per_page
        in: query
        description: Number of results per page. Defaults to 50.
        schema:
          type: integer
          minimum: 1
          maximum: 100
      - name: include_totals
        in: query
        description: Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).
        schema:
          type: boolean
      - name: from
        in: query
        description: Optional Id from which to start selection.
        schema:
          type: string
      - name: take
        in: query
        description: Number of results per page. Defaults to 50.
        schema:
          type: integer
          minimum: 1
          maximum: 100
      responses:
        '200':
          description: Groups successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListGroupsResponseContent'
        '400':
          description: Invalid request query string. The message will vary depending on the cause.
          x-description-1: Invalid query string paging options. The message will vary depending on the cause
        '401':
          description: Invalid token.
          x-description-1: Invalid signature received for JSON Web Token validation.
          x-description-2: Client is not global.
        '403':
          description: 'Insufficient scope; expected any of: read:groups.'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: get_groups
      x-release-lifecycle: EA
      x-operation-name: list
      x-operation-request-parameters-name: ListGroupsRequestParameters
      x-operation-group: groups
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:groups
  /groups/{id}:
    get:
      summary: Get a Group
      description: 'Retrieve a group by its ID.

        '
      tags:
      - groups
      parameters:
      - name: id
        in: path
        description: Unique identifier for the group (service-generated).
        required: true
        schema:
          type: string
          minLength: 18
          maxLength: 26
          pattern: ^grp_[1-9a-km-zA-HJ-NP-Z]{14,22}$
      responses:
        '200':
          description: Group successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGroupResponseContent'
        '400':
          description: Invalid request query string. The message will vary depending on the cause.
        '401':
          description: Invalid token.
          x-description-1: Invalid signature received for JSON Web Token validation.
          x-description-2: Client is not global.
        '403':
          description: 'Insufficient scope; expected any of: read:groups.'
        '404':
          description: The group does not exist.
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: get_group
      x-release-lifecycle: EA
      x-operation-name: get
      x-operation-request-parameters-name: getGroupRequestParameters
      x-operation-group: groups
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:groups
    delete:
      summary: Delete a Group
      description: 'Delete a group by its ID.

        '
      tags:
      - groups
      parameters:
      - name: id
        in: path
        description: Unique identifier for the group (service-generated).
        required: true
        schema:
          type: string
          minLength: 18
          maxLength: 26
          pattern: ^grp_[1-9a-km-zA-HJ-NP-Z]{14,22}$
      responses:
        '204':
          description: Group successfully deleted.
        '401':
          description: Invalid token.
          x-description-1: Invalid signature received for JSON Web Token validation.
          x-description-2: Client is not global.
        '403':
          description: 'Insufficient scope; expected any of: delete:groups.'
        '404':
          description: The group does not exist.
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: delete_group
      x-release-lifecycle: EA
      x-operation-name: delete
      x-operation-request-parameters-name: deleteGroupRequestParameters
      x-operation-group: groups
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - delete:groups
  /groups/{id}/members:
    get:
      summary: Get Group Members
      description: 'List all users that are a member of this group.

        '
      tags:
      - groups
      parameters:
      - name: id
        in: path
        description: Unique identifier for the group (service-generated).
        required: true
        schema:
          type: string
          minLength: 18
          maxLength: 26
          pattern: ^grp_[1-9a-km-zA-HJ-NP-Z]{14,22}$
      - name: fields
        in: query
        description: A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields
        schema:
          type: string
          maxLength: 256
          pattern: ^((id)|(member_type)|(type)|(connection_id)|(created_at))(,((id)|(member_type)|(type)|(connection_id)|(created_at)))*$
      - name: include_fields
        in: query
        description: Whether specified fields are to be included (true) or excluded (false).
        schema:
          type: boolean
      - name: from
        in: query
        description: Optional Id from which to start selection.
        schema:
          type: string
      - name: take
        in: query
        description: Number of results per page. Defaults to 50.
        schema:
          type: integer
          minimum: 1
          maximum: 100
      responses:
        '200':
          description: Group members successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGroupMembersResponseContent'
        '400':
          description: Invalid request query string. The message will vary depending on the cause.
        '401':
          description: Invalid token.
          x-description-1: Invalid signature received for JSON Web Token validation.
          x-description-2: Client is not global.
        '403':
          description: 'Insufficient scope; expected any of: read:group_members.'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: get_group_members
      x-release-lifecycle: EA
      x-operation-name: get
      x-operation-request-parameters-name: GetGroupMembersRequestParameters
      x-operation-group:
      - groups
      - members
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:group_members
components:
  schemas:
    GroupMember:
      type: object
      description: Represents the metadata of a group membership.
      additionalProperties: true
      properties:
        id:
          type: string
          description: Unique identifier for the member.
        member_type:
          $ref: '#/components/schemas/GroupMemberTypeEnum'
        type:
          $ref: '#/components/schemas/GroupTypeEnum'
        connection_id:
          type: string
          description: Identifier for the connection this group belongs to (if a connection group).
          format: connection-id
        created_at:
          type: string
          description: Timestamp of when the membership was created.
          format: date-time
    GetGroupMembersResponseContent:
      type: object
      additionalProperties: false
      required:
      - members
      properties:
        members:
          type: array
          items:
            $ref: '#/components/schemas/GroupMember'
        next:
          type: string
          description: A cursor to be used as the "from" query parameter for the next page of results.
    GroupTypeEnum:
      type: string
      description: Type of the group.
      enum:
      - connection
      - organization
      - tenant
    ListGroupsPaginatedResponseContent:
      type: object
      additionalProperties: false
      required:
      - groups
      properties:
        groups:
          type: array
          items:
            $ref: '#/components/schemas/Group'
        next:
          type: string
          description: A cursor to be used as the "from" query parameter for the next page of results.
        start:
          type: number
        limit:
          type: number
        total:
          type: number
    GetGroupResponseContent:
      type: object
      description: Represents the metadata of a group. Member lists are retrieved via a separate endpoint.
      additionalProperties: true
      required:
      - id
      - name
      - created_at
      - updated_at
      - tenant_name
      properties:
        id:
          type: string
          description: Unique identifier for the group (service-generated).
          minLength: 18
          maxLength: 26
          pattern: ^grp_[1-9a-km-zA-HJ-NP-Z]{14,22}$
        name:
          type: string
          description: Name of the group. Must be unique within its connection. Must contain between 1 and 128 printable ASCII characters.
          minLength: 1
          maxLength: 128
          pattern: ^[\x20-\x7E]+$
        external_id:
          type: string
          description: External identifier for the group, often used for SCIM synchronization. Max length of 256 characters.
          maxLength: 256
        connection_id:
          type: string
          description: Identifier for the connection this group belongs to (if a connection group).
          format: connection-id
        tenant_name:
          type: string
          description: Identifier for the tenant this group belongs to.
          minLength: 3
          pattern: ^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$
        created_at:
          type: string
          description: Timestamp of when the group was created.
          format: date-time
        updated_at:
          type: string
          description: Timestamp of when the group was last updated.
          format: date-time
    Group:
      type: object
      description: Represents the metadata of a group. Member lists are retrieved via a separate endpoint.
      additionalProperties: true
      properties:
        id:
          type: string
          description: Unique identifier for the group (service-generated).
          minLength: 18
          maxLength: 26
          pattern: ^grp_[1-9a-km-zA-HJ-NP-Z]{14,22}$
        name:
          type: string
          description: Name of the group. Must be unique within its connection. Must contain between 1 and 128 printable ASCII characters.
          minLength: 1
          maxLength: 128
          pattern: ^[\x20-\x7E]+$
        external_id:
          type: string
          description: External identifier for the group, often used for SCIM synchronization. Max length of 256 characters.
          maxLength: 256
        connection_id:
          type: string
          description: Identifier for the connection this group belongs to (if a connection group).
          format: connection-id
        tenant_name:
          type: string
          description: Identifier for the tenant this group belongs to.
          minLength: 3
          pattern: ^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$
        created_at:
          type: string
          description: Timestamp of when the group was created.
          format: date-time
        updated_at:
          type: string
          description: Timestamp of when the group was last updated.
          format: date-time
    GroupMemberTypeEnum:
      type: string
      description: Type of the member.
      enum:
      - user
      - group
    ListGroupsResponseContent:
      oneOf:
      - type: array
        items:
          $ref: '#/components/schemas/Group'
      - $ref: '#/components/schemas/ListGroupsPaginatedResponseContent'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: jwt
    oAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: /oauth/token/
          x-form-parameters:
            audience: /api/v2/
          scopes:
            create:actions: Create Actions
            read:actions: Read Actions
            update:actions: Update Actions
            delete:actions: Delete Actions
            read:anomaly_blocks: Read Anomaly Blocks
            delete:anomaly_blocks: Delete Anomaly Blocks
            read:attack_protection: Read Attack Protection
            update:attack_protection: Update Attack Protection
            create:authentication_methods: Create Authentication Methods
            read:authentication_methods: Read Authentication Methods
            update:authentication_methods: Update Authentication Methods
            delete:authentication_methods: Delete Authentication Methods
            read:branding: Read Branding
            update:branding: Update Branding
            delete:branding: Delete Branding
            create:client_credentials: Create Client Credentials
            read:client_credentials: Read Client Credentials
            update:client_credentials: Update Client Credentials
            delete:client_credentials: Delete Client Credentials
            create:client_grants: Create Client Grants
            read:client_grants: Read Client Grants
            update:client_grants: Update Client Grants
            delete:client_grants: Delete Client Grants
            read:client_keys: Read Client Keys
            update:client_keys: Update Client Keys
            read:client_summary: Read Client Summary
            update:client_token_vault_privileged_access: Update Client Token Vault Privileged Access
            create:clients: Create Clients
            read:clients: Read Clients
            update:clients: Update Clients
            delete:clients: Delete Clients
            create:connection_profiles: Create Connection Profiles
            read:connection_profiles: Read Connection Profiles
            update:connection_profiles: Update Connection Profiles
            delete:connection_profiles: Delete Connection Profiles
            create:connections: Create Connections
            read:connections: Read Connections
            update:connections: Update Connections
            delete:connections: Delete Connections
            create:connections_keys: Create Connections Keys
            read:connections_keys: Read Connections Keys
            update:connections_keys: Update Connections Keys
            read:current_user: Read Current User
            delete:current_user: Delete Current User
            create:current_user_device_credentials: Create Current User Device Credentials
            delete:current_user_device_credentials: Delete Current User Device Credentials
            update:current_user_identities: Update Current User Identities
            update:current_user_metadata: Update Current User Metadata
            create:custom_domains: Create Custom Domains
            read:custom_domains: Read Custom Domains
            update:custom_domains: Update Custom Domains
            delete:custom_domains: Delete Custom Domains
            create:custom_signing_keys: Create Custom Signing Keys
            read:custom_signing_keys: Read Custom Signing Keys
            update:custom_signing_keys: Update Custom Signing Keys
            delete:custom_signing_keys: Delete Custom Signing Keys
            read:device_credentials: Read Device Credentials
            delete:device_credentials: Delete Device Credentials
            create:directory_provisionings: Create Directory Provisionings
            read:directory_provisionings: Read Directory Provisionings
            update:directory_provisionings: Update Directory Provisionings
            delete:directory_provisionings: Delete Directory Provisionings
            create:email_provider: Create Email Provider
            read:email_provider: Read Email Provider
            update:email_provider: Update Email Provider
            delete:email_provider: Delete Email Provider
            create:email_templates: Create Email Templates
            read:email_templates: Read Email Templates
            update:email_templates: Update Email Templates
            create:encryption_keys: Create Encryption Keys
            read:encryption_keys: Read Encryption Keys
            update:encryption_keys: Update Encryption Keys
            delete:encryption_keys: Delete Encryption Keys
            read:event_deliveries: Read Event Deliveries
            update:event_deliveries: Update Event Deliveries
            create:event_streams: Create Event Streams
            read:event_streams: Read Event Streams
            update:event_streams: Update Event Streams
            delete:event_streams: Delete Event Streams
            read:events: Read Events
            read:federated_connections_tokens: Read Federated Connections Tokens
            delete:federated_connections_tokens: Delete Federated Connections Tokens
            create:flows: Create Flows
            read:flows: Read Flows
            update:flows: Update Flows
            delete:flows: Delete Flows
            read:flows_executions: Read Flows Executions
            delete:flows_executions: Delete Flows Executions
            create:flows_vault_connections: Create Flows Vault Connections
            read:flows_vault_connections: Read Flows Vault Connections
            update:flows_vault_connections: Update Flows Vault Connections
            delete:flows_vault_connections: Delete Flows Vault Connections
            create:forms: Create Forms
            read:forms: Read Forms
            update:forms: Update Forms
            delete:forms: Delete Forms
            read:grants: Read Grants
            delete:grants: Delete Grants
            read:group_members: Read Group Members
            read:groups: Read Groups
            delete:groups: Delete Groups
            create:guardian_enrollment_tickets: Create Guardian Enrollment Tickets
            read:guardian_enrollments: Read Guardian Enrollments
            delete:guardian_enrollments: Delete Guardian Enrollments
            read:guardian_factors: Read Guardian Factors
            update:guardian_factors: Update Guardian Factors
            create:hooks: Create Hooks
            read:hooks: Read Hooks
            update:hooks: Update Hooks
            delete:hooks: Delete Hooks
            create:log_streams: Create Log Streams
            read:log_streams: Read Log Streams
            update:log_streams: Update Log Streams
            delete:log_streams: Delete Log Streams
            read:logs: Read Logs
            read:logs_users: Read Logs Users
            read:mfa_policies: Read Mfa Policies
            update:mfa_policies: Update Mfa Policies
            create:network_acls: Create Network Acls
            read:network_acls: Read Network Acls
            update:network_acls: Update Network Acls
            delete:network_acls: Delete Network Acls
            create:organization_client_grants: Create Organization Client Grants
            read:organization_client_grants: Read Organization Client Grants
            delete:organization_client_grants: Delete Organization Client Grants
            create:organization_connections: Create Organization Connections
            read:organization_connections: Read Organization Connections
            update:organization_connections: Update Organization Connections
            delete:organization_connections: Delete Organization Connections
            create:organization_discovery_domains: Create Organization Discovery Domains
            read:organization_discovery_domains: Read Organization Discovery Domains
            update:organization_discovery_domains: Update Organization Discovery Domains
            delete:organization_discovery_domains: Delete Organization Discovery Domains
            create:organization_invitations: Create Organization Invitations
            read:organization_invitations: Read Organization Invitations
            delete:organization_invitations: Delete Organization Invitations
            create:organization_member_roles: Create Organization Member Roles
            read:organization_member_roles: Read Organization Member Roles
            delete:organization_member_roles: Delete Organization Member Roles
            create:organization_members: Create Organization Members
            read:organization_members: Read Organization Members
            delete:organization_members: Delete Organization Members
            create:organizations: Create Organizations
            read:organizations: Read Organizations
            update:organizations: Update Organizations
            delete:organizations: Delete Organizations
            read:organizations_summary: Read Organizations Summary
            create:phone_providers: Create Phone Providers
            read:phone_providers: Read Phone Providers
            update:phone_providers: Update Phone Providers
            delete:phone_providers: Delete Phone Providers
            create:phone_templates: Create Phone Templates
            read:phone_templates: Read Phone Templates
            update:phone_templates: Update Phone Templates
            delete:phone_templates: Delete Phone Templates
            read:prompts: Read Prompts
            update:prompts: Update Prompts
            read:refresh_tokens: Read Refresh Tokens
            update:refresh_tokens: Update Refresh Tokens
            delete:refresh_tokens: Delete Refresh Tokens
            create:resource_servers: Create Resource Servers
            read:resource_servers: Read Resource Servers
            update:resource_servers: Update Resource Servers
            delete:resource_servers: Delete Resource Servers
            create:role_members: Create Role Members
            read:role_members: Read Role Members
            delete:role_members: Delete Role Members
            create:roles: Create Roles
            read:roles: Read Roles
            update:roles: Update Roles
            delete:roles: Delete Roles
            create:rules: Create Rules
            read:rules: Read Rules
            update:rules: Update Rules
            delete:rules: Delete Rules
            read:rules_configs: Read Rules Configs
            update:rules_configs: Update Rules Configs
            delete:rules_configs: Delete Rules Configs
            create:scim_config: Create Scim Config
            read:scim_config: Read Scim Config
            update:scim_config: Update Scim Config
            delete:scim_config: Delete Scim Config
            create:scim_token: Create Scim Token
            read:scim_token: Read Scim Token
            delete:scim_token: Delete Scim Token
            read:self_service_profile_custom_texts: Read Self Service Profile Custom Texts
            update:self_service_profile_custom_texts: Update Self Service Profile Custom Texts
            create:self_service_profiles: Create Self Service Profiles
            read:self_service_profiles: Read Self Service Profiles
            update:self_service_profiles: Update Self Service Profiles
            delete:self_service_profiles: Delete Self Service Profiles
            read:sessions: Read Sessions
            update:sessions: Update Sessions
            delete:sessions: Delete Sessions
            create:signing_keys: Create Signing Keys
            read:signing_keys: Read Signing Keys
            update:signing_keys: Update Signing Keys
            create:sso_access_tickets: Create Sso Access Tickets
            delete:sso_access_tickets: Delete Sso Access Tickets
            read:stats: Read Stats
            read:tenant_settings: Read Tenant Settings
            update:tenant_settings: Update Tenant Settings
            create:token_exchange_profiles: Create Token Exchange Profiles
            read:token_exchange_profiles: Read Token Exchange Profiles
            update:token_exchange_profiles: Update Token Exchange Profiles
            delete:token_exchange_profiles: Delete Token Exchange Profiles
            create:user_attribute_profiles: Create User Attribute Profiles
            read:user_attribute_profiles: Read User Attribute Profiles
            update:user_attribute_profiles: Update User Attribute Profiles
            delete:user_attribute_profiles: Delete User Attribute Profiles
            read:user_idp_tokens: Read User Idp Tokens
            create:user_tickets: Create User Tickets
            create:users: Create Users
            read:users: Read Users
            update:users: Update Users
            delete:users: Delete Users
            update:users_app_metadata: Update Users App Metadata
            create:vdcs_templates: Create Vdcs Templates
            read:vdcs_templates: Read Vdcs Templates
            update:vdcs_templates: Update Vdcs Templates
            delete:vdcs_templates: Delete Vdcs Templates
externalDocs:
  description: Auth0 Management API Documentation
  url: https://auth0.com/docs/api/management/v2/