Group APIs

    Overview

    A FusionAuth Group is a named object that optionally contains one to many Application Roles.

    When a Group does not contain any Application Roles it can still be utilized to logically associate users. Assigning Application Roles to a group allow it to be used to dynamically manage Role assignment to registered Users. In this second scenario as long as a User is registered to an Application the Group membership will allow them to inherit the corresponding Roles from the Group.

    The following APIs are provided to manage Groups and Group Membership.

    Create a Group

    This API is used to create a new Group.

    Request

    Create a Group with a randomly generated Id

    URI

    POST /api/group

    Request Headers

    X-FusionAuth-TenantId [String] Optional

    The unique Id of the tenant used to scope this API request.

    When only a single tenant is configured the tenant Id can be assumed and this additional header is optional. Once more than one tenant has been configured in FusionAuth the tenant Id is required for this request. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.

    See Making an API request using a Tenant Id for additional information.

    Create a Group with the provided unique Id

    URI

    POST /api/group/{groupId}

    Request Parameters

    groupId [UUID] Optional defaults to secure random UUID

    The Id to use for the new Group. If not specified a secure random UUID will be generated.

    Request Headers

    X-FusionAuth-TenantId [String] Optional

    The unique Id of the tenant used to scope this API request.

    When only a single tenant is configured the tenant Id can be assumed and this additional header is optional. Once more than one tenant has been configured in FusionAuth the tenant Id is required for this request. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.

    See Making an API request using a Tenant Id for additional information.

    Request Body

    group.data [Object] Optional

    An object that can hold any information about the Group that should be persisted.

    group.name [String] Required

    The name of the Group.

    roleIds [Array<UUID>] Optional

    The Application Roles to assign to this group.

    Example Request JSON
    
{
  "group": {
    "data": {
      "description": "This group assigns members admin access to all applications.",
      "external": {
        "createdAt": 1503000771468
      }
    },
    "name": "Company Admins"
  },
  "roleIds": [
    "68259c40-0b4e-4245-8956-7e5af0959c2b",
    "00f24e72-52e2-4f55-8ea1-6a06bfe10df5",
    "11a5b1b8-7ef5-476f-af7d-69e19796fa8b"
  ]
}

    Response

    The response for this API contains the Group that was created.

    Table 1. Response Codes
    Code Description

    200

    The request was successful. The response will contain a JSON body.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    503

    The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

    Response Body

    group.data [Object]

    An object that can hold any information about the Group that should be persisted.

    group.id [UUID]

    The unique Id of the Group.

    group.insertInstant [Long]

    The instant that the Group was added to the FusionAuth database.

    group.lastUpdateInstant [Long]

    The instant that the Group was updated in the FusionAuth database.

    group.name [String]

    The name of the Group.

    group.roles [Map<UUID, List<Object>]

    The roles assigned to this Group. The map key is the Application Id, the value is an array of Application Roles.

    group.roles[applicationId][x].description [String]

    The description of the role.

    group.roles[applicationId][x].id [UUID]

    The Application Role Unique Id

    group.roles[applicationId][x].name [String]

    The name of the Group.

    group.roles[applicationId][x].isDefault [Boolean]

    Whether or not the Role is a default role. A default role is automatically assigned to a user during registration if no roles are provided.

    group.roles[applicationId][x].isSuperRole [Boolean]

    Whether or not the Role is a considered to be a super user role. This is a marker to indicate that it supersedes all other roles. FusionAuth will attempt to enforce this contract when using the web UI, it is not enforced programmatically when using the API.

    Example Response JSON
    
{
  "group": {
    "data": {
      "description": "This group assigns members admin access to all applications.",
      "external": {
        "createdAt": 1503000771468
      }
    },
    "id": "1188edfc-cef3-4555-910e-181ddf6153c0",
    "insertInstant": 1595361142909,
    "lastUpdateInstant": 1595361143101,
    "name": "Company Admins",
    "roles": {
      "931fded0-f917-439d-b447-d7f21b37a134": [
        {
          "id": "68259c40-0b4e-4245-8956-7e5af0959c2b",
          "isDefault": false,
          "isSuperRole": true,
          "name": "admin"
        }
      ],
      "07d1efe7-9a14-433d-8247-2235e67736f0": [
        {
          "id": "00f24e72-52e2-4f55-8ea1-6a06bfe10df5",
          "isDefault": false,
          "isSuperRole": true,
          "name": "ADMIN"
        }
      ],
      "d23e9a51-2b20-4384-9c74-432e12219aad": [
        {
          "id": "11a5b1b8-7ef5-476f-af7d-69e19796fa8b",
          "isDefault": false,
          "isSuperRole": true,
          "name": "Administrator"
        }
      ]
    }
  }
}

    Retrieve a Group

    This API is used to retrieve a single Group by unique Id or all of the configured Groups.

    Request

    Retrieve all of the Groups

    URI

    GET /api/group

    Request Headers

    X-FusionAuth-TenantId [String] Optional

    The unique Id of the tenant used to scope this API request.

    The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon the request parameters or it is otherwise not required.

    Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.

    See Making an API request using a Tenant Id for additional information.

    Retrieve a Group by Id

    URI

    GET /api/group/{groupId}

    Request Parameters

    groupId [UUID] Required

    The unique Id of the Group to retrieve.

    Request Headers

    X-FusionAuth-TenantId [String] Optional

    The unique Id of the tenant used to scope this API request.

    The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon the request parameters or it is otherwise not required.

    Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.

    See Making an API request using a Tenant Id for additional information.

    Response

    The response for this API contains either a single Group or all of the Groups. When you call this API with an Id the response will contain a single Group. When you call this API without an Id the response will contain all of the Groups. Both response types are defined below along with an example JSON response.

    Table 2. Response Codes
    Code Description

    200

    The request was successful. The response will contain a JSON body.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    404

    The object you requested doesn’t exist. The response will be empty.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    503

    The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

    Response Body

    group.data [Object]

    An object that can hold any information about the Group that should be persisted.

    group.id [UUID]

    The unique Id of the Group.

    group.insertInstant [Long]

    The instant that the Group was added to the FusionAuth database.

    group.lastUpdateInstant [Long]

    The instant that the Group was updated in the FusionAuth database.

    group.name [String]

    The name of the Group.

    group.roles [Map<UUID, List<Object>]

    The roles assigned to this Group. The map key is the Application Id, the value is an array of Application Roles.

    group.roles[applicationId][x].description [String]

    The description of the role.

    group.roles[applicationId][x].id [UUID]

    The Application Role Unique Id

    group.roles[applicationId][x].name [String]

    The name of the Group.

    group.roles[applicationId][x].isDefault [Boolean]

    Whether or not the Role is a default role. A default role is automatically assigned to a user during registration if no roles are provided.

    group.roles[applicationId][x].isSuperRole [Boolean]

    Whether or not the Role is a considered to be a super user role. This is a marker to indicate that it supersedes all other roles. FusionAuth will attempt to enforce this contract when using the web UI, it is not enforced programmatically when using the API.

    Example Response JSON
    
{
  "group": {
    "data": {
      "description": "This group assigns members admin access to all applications.",
      "external": {
        "createdAt": 1503000771468
      }
    },
    "id": "1188edfc-cef3-4555-910e-181ddf6153c0",
    "insertInstant": 1595361142909,
    "lastUpdateInstant": 1595361143101,
    "name": "Company Admins",
    "roles": {
      "931fded0-f917-439d-b447-d7f21b37a134": [
        {
          "id": "68259c40-0b4e-4245-8956-7e5af0959c2b",
          "isDefault": false,
          "isSuperRole": true,
          "name": "admin"
        }
      ],
      "07d1efe7-9a14-433d-8247-2235e67736f0": [
        {
          "id": "00f24e72-52e2-4f55-8ea1-6a06bfe10df5",
          "isDefault": false,
          "isSuperRole": true,
          "name": "ADMIN"
        }
      ],
      "d23e9a51-2b20-4384-9c74-432e12219aad": [
        {
          "id": "11a5b1b8-7ef5-476f-af7d-69e19796fa8b",
          "isDefault": false,
          "isSuperRole": true,
          "name": "Administrator"
        }
      ]
    }
  }
}

    Response Body

    groups [Array]

    The list of Group objects.

    groups[x].data [Object]

    An object that can hold any information about the Group that should be persisted.

    groups[x].id [UUID]

    The name of the Group.

    group[x].insertInstant [Long]

    The instant that the Group was added to the FusionAuth database.

    group[x].lastUpdateInstant [Long]

    The instant that the Group was updated in the FusionAuth database.

    groups[x].name [String]

    The name of the Group.

    groups[x].roles [Map<UUID, List<Object>]

    The roles assigned to this Group. The map key is the Application Id, the value is an array of Application Roles.

    groups[x].roles[applicationId][x].description [String]

    The description of the role.

    groups[x].roles[applicationId][x].id [UUID]

    The Application Role Unique Id

    groups[x].roles[applicationId][x].name [String]

    The name of the Group.

    groups[x].roles[applicationId][x].isDefault [Boolean]

    Whether or not the Role is a default role. A default role is automatically assigned to a user during registration if no roles are provided.

    groups[x].roles[applicationId][x].isSuperRole [Boolean]

    Whether or not the Role is a considered to be a super user role. This is a marker to indicate that it supersedes all other roles. FusionAuth will attempt to enforce this contract when using the web UI, it is not enforced programmatically when using the API.

    Example Response JSON
    
{
  "groups": [
    {
      "data": {
        "description": "This group assigns members admin access to all applications.",
        "external": {
          "createdAt": 1503000771468
        }
      },
      "id": "1188edfc-cef3-4555-910e-181ddf6153c0",
      "insertInstant": 1595361142909,
      "lastUpdateInstant": 1595361143101,
      "name": "Company Admins",
      "roles": {
        "931fded0-f917-439d-b447-d7f21b37a134": [
          {
            "id": "68259c40-0b4e-4245-8956-7e5af0959c2b",
            "isDefault": false,
            "isSuperRole": true,
            "name": "admin"
          }
        ],
        "07d1efe7-9a14-433d-8247-2235e67736f0": [
          {
            "id": "00f24e72-52e2-4f55-8ea1-6a06bfe10df5",
            "isDefault": false,
            "isSuperRole": true,
            "name": "ADMIN"
          }
        ],
        "d23e9a51-2b20-4384-9c74-432e12219aad": [
          {
            "id": "11a5b1b8-7ef5-476f-af7d-69e19796fa8b",
            "isDefault": false,
            "isSuperRole": true,
            "name": "Administrator"
          }
        ]
      }
    }
  ]
}

    Update a Group

    This API is used to update an existing Group.

    You must specify the Id of the Group you are updating on the URI.

    You must specify all of the properties of the Group when calling this API with the PUT HTTP method. When used with PUT, this API doesn’t merge the existing Group and your new data. It replaces the existing Group with your new data.

    Utilize the PATCH HTTP method to send specific changes to merge into an existing Group.

    Request

    Update the Group with the given Id

    URI

    PUT /api/group/{groupId}

    PATCH /api/group/{groupId}

    Available since 1.39.0

    When using the PATCH method, you can either use the same request body documentation that is provided for the PUT request for backward compatibility. Or you may use either JSON Patch/RFC 6902 or JSON Merge Patch/RFC 7396. See the PATCH documentation for more information.

    Available since 1.12.0

    When using the PATCH method, use the same request body documentation that is provided for the PUT request. The PATCH method will merge the provided request parameters into the existing object, this means all parameters are optional when using the PATCH method and you only provide the values you want changed. A null value can be used to remove a value. Patching an Array will result in all values from the new list being appended to the existing list, this is a known limitation to the current implementation of PATCH.

     

    Request Parameters

    groupId [UUID] Required

    The Id of the Group to update.

    Request Headers

    X-FusionAuth-TenantId [String] Optional

    The unique Id of the tenant used to scope this API request.

    The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon the request parameters or it is otherwise not required.

    Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.

    See Making an API request using a Tenant Id for additional information.

    Request Body

    group.data [Object] Optional

    An object that can hold any information about the Group that should be persisted.

    group.name [String] Required

    The name of the Group.

    roleIds [Array<UUID>] Optional

    The Application Roles to assign to this group.

    Example Request JSON
    
{
  "group": {
    "data": {
      "description": "This group assigns members admin access to all applications.",
      "external": {
        "createdAt": 1503000771468
      }
    },
    "name": "Company Admins"
  },
  "roleIds": [
    "68259c40-0b4e-4245-8956-7e5af0959c2b",
    "00f24e72-52e2-4f55-8ea1-6a06bfe10df5",
    "11a5b1b8-7ef5-476f-af7d-69e19796fa8b"
  ]
}

    Response

    The response for this API contains the Group that was updated.

    Table 3. Response Codes
    Code Description

    200

    The request was successful. The response will contain a JSON body.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    404

    The object you are trying to update doesn’t exist. The response will be empty.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    503

    The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

    Response Body

    group.data [Object]

    An object that can hold any information about the Group that should be persisted.

    group.id [UUID]

    The unique Id of the Group.

    group.insertInstant [Long]

    The instant that the Group was added to the FusionAuth database.

    group.lastUpdateInstant [Long]

    The instant that the Group was updated in the FusionAuth database.

    group.name [String]

    The name of the Group.

    group.roles [Map<UUID, List<Object>]

    The roles assigned to this Group. The map key is the Application Id, the value is an array of Application Roles.

    group.roles[applicationId][x].description [String]

    The description of the role.

    group.roles[applicationId][x].id [UUID]

    The Application Role Unique Id

    group.roles[applicationId][x].name [String]

    The name of the Group.

    group.roles[applicationId][x].isDefault [Boolean]

    Whether or not the Role is a default role. A default role is automatically assigned to a user during registration if no roles are provided.

    group.roles[applicationId][x].isSuperRole [Boolean]

    Whether or not the Role is a considered to be a super user role. This is a marker to indicate that it supersedes all other roles. FusionAuth will attempt to enforce this contract when using the web UI, it is not enforced programmatically when using the API.

    Example Response JSON
    
{
  "group": {
    "data": {
      "description": "This group assigns members admin access to all applications.",
      "external": {
        "createdAt": 1503000771468
      }
    },
    "id": "1188edfc-cef3-4555-910e-181ddf6153c0",
    "insertInstant": 1595361142909,
    "lastUpdateInstant": 1595361143101,
    "name": "Company Admins",
    "roles": {
      "931fded0-f917-439d-b447-d7f21b37a134": [
        {
          "id": "68259c40-0b4e-4245-8956-7e5af0959c2b",
          "isDefault": false,
          "isSuperRole": true,
          "name": "admin"
        }
      ],
      "07d1efe7-9a14-433d-8247-2235e67736f0": [
        {
          "id": "00f24e72-52e2-4f55-8ea1-6a06bfe10df5",
          "isDefault": false,
          "isSuperRole": true,
          "name": "ADMIN"
        }
      ],
      "d23e9a51-2b20-4384-9c74-432e12219aad": [
        {
          "id": "11a5b1b8-7ef5-476f-af7d-69e19796fa8b",
          "isDefault": false,
          "isSuperRole": true,
          "name": "Administrator"
        }
      ]
    }
  }
}

    Delete a Group

    This API is used to permanently delete a Group. Deleting a Group that has Application Roles will effectively modify User Registrations by removing these Roles from Group members.

    Request

    Delete a Group by Id

    URI

    DELETE /api/group/{groupId}

    Request Parameters

    groupId [UUID] Required

    The unique Id of the Group to delete.

    Request Headers

    X-FusionAuth-TenantId [String] Optional

    The unique Id of the tenant used to scope this API request.

    The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon the request parameters or it is otherwise not required.

    Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.

    See Making an API request using a Tenant Id for additional information.

    Response

    This API does not return a JSON response body.

    Table 4. Response Codes
    Code Description

    200

    The request was successful. The response will be empty.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    404

    The object you are trying to delete doesn’t exist. The response will be empty.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    503

    The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

    Add Users to a Group

    This API is used to add Users to a Group. A User that is added to a Group is called a member, a user can belong to one to many Groups.

    Adding a User to a Group can be used to logically group users, Group members can be returned by the Search API by searching by the Group Id. Application Roles may also be managed by a Group membership. When a User becomes a member of a Group they will inherit the Application Roles assigned to the Group for their registered Applications. If a User is not registered for an Application the Application Roles for that Application will not be applied to the User.

    Request

    Add Users to Group

    URI

    POST /api/group/member

    Request Headers

    X-FusionAuth-TenantId [String] Optional

    The unique Id of the tenant used to scope this API request.

    The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon the request parameters or it is otherwise not required.

    Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.

    See Making an API request using a Tenant Id for additional information.

    Request Body

    members[groupId] [Array] Required

    The key is the Id of the Group to which to add Users. The value is an array of objects which specify the Members to be added.

    members[groupId][x].data [Object] Optional

    An object that can hold any information about the Group Member that should be persisted.

    members[groupId][x].id [UUID] Optional

    The unique Id of this Group Member. If not specified a secure random UUID will be generated.

    members[groupId][x].userId [UUID] Required

    The User Id to add as a Member of this Group.

    Example Request JSON
    
{
  "members": {
    "1188edfc-cef3-4555-910e-181ddf6153c0": [
      {
        "data": {
          "fruit": "orange"
        },
        "userId": "00000000-0000-0001-0000-000000000000"
      }
    ]
  }
}

    Response

    Table 5. Response Codes
    Code Description

    200

    The request was successful. The response will contain a JSON body.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    503

    The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

    Response Body

    members[groupId][x].data [Object]

    An object that can hold any information about the Group Member that should be persisted.

    members[groupId][x].id [UUID]

    The unique Id of this Group Member. This is not the User Id, but a unique Id for the membership.

    members[groupId][x].insertInstant [Long]

    The instant that this membership was created.

    members[groupId][x].userId [UUID]

    The User Id of the Group Member.

    Example Response JSON
    
{
  "members": {
    "1188edfc-cef3-4555-910e-181ddf6153c0": [
      {
        "data": {
          "fruit": "orange"
        },
        "id": "47ffe8c2-920a-49cc-bfa8-b84889db615e",
        "insertInstant": 1503513015493,
        "userId": "00000000-0000-0001-0000-000000000000"
      }
    ]
  }
}

    Update Users in a Group

    This API has been available since 1.36.0

    This API is used to completely replace the existing membership of a Group. Calling this API is equivalent to removing all Users from a Group and then making a POST request to the /api/group/member to add Users to the Group. Use this API with caution.

    Request

    Update Users in a Group

    URI

    PUT /api/group/member

    Request Headers

    X-FusionAuth-TenantId [String] Optional

    The unique Id of the tenant used to scope this API request.

    The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon the request parameters or it is otherwise not required.

    Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.

    See Making an API request using a Tenant Id for additional information.

    Request Body

    members[groupId] [Array] Required

    The key is the Id of the Group to which to add Users. The value is an array of objects which specify the Members to be added.

    members[groupId][x].data [Object] Optional

    An object that can hold any information about the Group Member that should be persisted.

    members[groupId][x].id [UUID] Optional

    The unique Id of this Group Member. If not specified a secure random UUID will be generated.

    members[groupId][x].userId [UUID] Required

    The User Id to add as a Member of this Group.

    Example Request JSON
    
{
  "members": {
    "1188edfc-cef3-4555-910e-181ddf6153c0": [
      {
        "data": {
          "fruit": "orange"
        },
        "userId": "00000000-0000-0001-0000-000000000000"
      }
    ]
  }
}

    Response

    Table 6. Response Codes
    Code Description

    200

    The request was successful. The response will contain a JSON body.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    503

    The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

    Response Body

    members[groupId][x].data [Object]

    An object that can hold any information about the Group Member that should be persisted.

    members[groupId][x].id [UUID]

    The unique Id of this Group Member. This is not the User Id, but a unique Id for the membership.

    members[groupId][x].insertInstant [Long]

    The instant that this membership was created.

    members[groupId][x].userId [UUID]

    The User Id of the Group Member.

    Example Response JSON
    
{
  "members": {
    "1188edfc-cef3-4555-910e-181ddf6153c0": [
      {
        "data": {
          "fruit": "orange"
        },
        "id": "47ffe8c2-920a-49cc-bfa8-b84889db615e",
        "insertInstant": 1503513015493,
        "userId": "00000000-0000-0001-0000-000000000000"
      }
    ]
  }
}

    Remove Users from a Group

    This API is used to remove Users from a Group. Removing a User from a Group removes their Group membership. Removing a User from a Group effectively modifies their assigned Roles if Application Roles are being managed through the Group membership.

    Request

    Remove a single User from a Group by Member Id

    URI

    DELETE /api/group/member/{memberId}

    Request Parameters

    memberId [UUID] Required

    The unique Id of the Group Member to delete.

    Request Headers

    X-FusionAuth-TenantId [String] Optional

    The unique Id of the tenant used to scope this API request.

    The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon the request parameters or it is otherwise not required.

    Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.

    See Making an API request using a Tenant Id for additional information.

    Remove a single User from a Group by User Id and Group Id

    URI

    DELETE /api/group/member?groupId={groupId}&userId={userId}

    Request Parameters

    groupId [UUID] Required

    The unique Id of the Group to remove the User from.

    userId [UUID] Required

    The unique Id of the User to remove from the Group.

    Request Headers

    X-FusionAuth-TenantId [String] Optional

    The unique Id of the tenant used to scope this API request.

    The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon the request parameters or it is otherwise not required.

    Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.

    See Making an API request using a Tenant Id for additional information.

    Remove all Users from a Group

    URI

    DELETE /api/group/member?groupId={groupId}

    Note, in version 1.36.0 the Member API supports the PUT method allowing you to replace all members in the Group.

    As of version 1.36.0 this API is deprecated, in favor of using the PUT method. Prefer the use of PUT /api/group/member with an empty array of members to effectively remove all members from the group.

    Request Parameters

    groupId [UUID] Required

    The unique Id of the Group.

    Request Headers

    X-FusionAuth-TenantId [String] Optional

    The unique Id of the tenant used to scope this API request.

    The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon the request parameters or it is otherwise not required.

    Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.

    See Making an API request using a Tenant Id for additional information.

    Remove Users from a Group by Member Id

    URI

    DELETE /api/group/member

    Request Headers

    X-FusionAuth-TenantId [String] Optional

    The unique Id of the tenant used to scope this API request.

    The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon the request parameters or it is otherwise not required.

    Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.

    See Making an API request using a Tenant Id for additional information.

    Request Body

    memberIds [Array] Required

    An array of member Ids to delete.

    Example Request JSON
    
{
  "memberIds": [
    "222b884b-a0a1-4563-a957-89c7c0513e6e",
    "80d474bf-0dee-4009-b793-ec1255693fa3",
    "16d98a8b-4205-4441-8831-7e3f73154134"
  ]
}

    Remove specified Users from a Group by Group Id

    URI

    DELETE /api/group/member

    Request Headers

    X-FusionAuth-TenantId [String] Optional

    The unique Id of the tenant used to scope this API request.

    The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon the request parameters or it is otherwise not required.

    Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.

    See Making an API request using a Tenant Id for additional information.

    Request Body

    members[groupId][x] [Array] Required

    An array of User Ids to remove from the Group specified by Group Id.

    Example Request JSON
    
{
  "members": {
    "1188edfc-cef3-4555-910e-181ddf6153c0": [
      "578e52df-83e8-48ca-899b-3aefd56e7fc5",
      "0928cf95-34d1-44cc-9114-da68a07e5ff8"
    ]
  }
}

    Response

    This API does not return a JSON response body.

    Table 7. Response Codes
    Code Description

    200

    The request was successful. The response will be empty.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    404

    The object you are trying to delete doesn’t exist. The response will be empty.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    503

    The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

    Search for Group Members

    This API has been available since 1.36.0

    The Group Member Search API allows you to search for Group Members with a paginated response.

    Request

    Search for all Group Members by Group Id

    URI

    GET /api/group/member/search?groupId={groupId}

    When calling the API using a GET request you will send the search criteria on the URL using request parameters. In order to simplify the example URL above, only the groupId parameter is shown, however you may add any of the documented request parameters to the URL.

    Request Parameters

    groupId [UUID] Optional

    The unique Id of the Group used to search for Group Members.

    numberOfResults [Integer] Optional defaults to 25

    The number of results to return from the search.

    orderBy [String] Optional defaults to name ASC

    The database column to order the search results on plus the order direction.

    The possible values are:

    • id - the id of the Group Member

    • insertInstant - the instant when the Group Member was created

    • groupId - the unique Id of the Group

    • userId - the unique Id of the User

    For example, to order the results by the insert instant in descending order, the value would be provided as insertInstant DESC. The final string is optional, can be set to ASC or DESC, or omitted and will default to ASC.

    startRow [Integer] Optional defaults to 0

    The offset row to return results from. If the search has 200 records in it and this is 50, it starts with row 50.

    userId [UUID] Optional

    The unique Id of the User to search for Group Members. A single user may belong to one or more Groups, so searching on this field may still produce multiple results.

    Search Group Members using the given search criteria

    URI

    POST /api/group/member/search

    When calling the API using a POST request you will send the search criteria in a JSON request body.

    Request Body

    search.groupId [UUID] Optional

    The unique Id of the Group used to search for Group Members.

    search.numberOfResults [Integer] Optional defaults to 25

    The number of results to return from the search.

    search.orderBy [String] Optional defaults to name ASC

    The database column to order the search results on plus the order direction.

    The possible values are:

    • id - the id of the Group Member

    • insertInstant - the instant when the Group Member was created

    • groupId - the unique Id of the Group

    • userId - the unique Id of the User

    For example, to order the results by the insert instant in descending order, the value would be provided as insertInstant DESC. The final string is optional, can be set to ASC or DESC, or omitted and will default to ASC.

    search.startRow [Integer] Optional defaults to 0

    The offset row to return results from. If the search has 200 records in it and this is 50, it starts with row 50.

    search.userId [UUID] Optional

    The unique Id of the User to search for Group Members. A single user may belong to one or more Groups, so searching on this field may still produce multiple results.

    Response

    Table 8. Response Codes
    Code Description

    200

    The request was successful. The response will contain a JSON body.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    Response Body

    members [Array]

    A list of the Group Members that matched the search criteria.

    members[x].data [Object]

    An object that can hold any information about the Group Member that should be persisted.

    members[x].groupId [UUID]

    The unique Group Id that indicates the Group this membership represents.

    members[x].id [UUID]

    The unique Id of this Group Member.

    members[x].insertInstant [Long]

    The instant that this membership was created.

    members[x].userId [UUID]

    The unique User Id that represents the User this membership represents.

    total [Integer]

    The total number of Group Members matching the search criteria. Use this value along with the numberOfResults and startRow in the Search request to perform pagination.

    Example Response JSON
    
{
  "members": [
    {
      "id": "47ffe8c2-920a-49cc-bfa8-b84889db615e",
      "groupId": "1188edfc-cef3-4555-910e-181ddf6153c0",
      "insertInstant": 1503513015493,
      "userId": "00000000-0000-0001-0000-000000000000"
    }
  ],
  "total": 1
}

    Feedback

    How helpful was this page?

    See a problem?

    File an issue in our docs repo

    Have a question or comment to share?

    Visit the FusionAuth community forum.