1. Development Integration
  2. /
  3. SDK
  4. /
  5. Java
  6. /

  7. Management module

  8. /

  9. Manage users

  10. /
  11. Determine whether the user has a certain role

Determine whether the user Yes No has a certain role

Update time: 2025-07-23 07:34:21
Edit

This document is automatically generated based on https://github.com/authing/authing-docs-factory and https://api-explorer.genauth.ai V3 API, and is consistent with API parameters and return results. If the description of this document is incorrect, please refer to V3 API.

Determine whether the user Yes No has a certain role through the user ID. It supports passing in multiple roles and can choose to specify the user ID type.

Method Name

ManagementClient.hasAnyRole

Request Parameters

NameType
Is it required
Default Value
Description
Example Value
rolesHasRoleRolesDto[]Yes-Role list
userIdstringYes-User's unique identifier, which can be Yes user ID, user name, email, phone number, externalId, or ID in the external identity source. For details, see the description of the userIdType field. The default is user id.6229ffaxxxxxxxxcade3e3d9
optionsHasAnyRoleOptionsDtoNo-Optional parameters

Sample Code

package test.management;

import cn.authing.sdk.java.client.ManagementClient;
import cn.authing.sdk.java.dto.HasAnyRoleReqDto;
import cn.authing.sdk.java.dto.HasAnyRoleRespDto;
import cn.authing.sdk.java.dto.HasRoleRolesDto;
import cn.authing.sdk.java.model.ManagementClientOptions;
import cn.authing.sdk.java.util.JsonUtils;

import java.util.ArrayList;
import java.util.List;

public class HasAnyRoleTest {
    // Need to be replaced with your GenAuth Access Key ID
    private static final String ACCESS_KEY_ID = "AUTHING_ACCESS_KEY_ID";
    // Need to be replaced with your GenAuth Access Key Secret
    private static final String ACCESS_KEY_SECRET = "AUTHING_ACCESS_KEY_SECRET";

    public static void main(String[] args) throws Throwable {
        ManagementClientOptions clientOptions = new ManagementClientOptions();
        clientOptions.setAccessKeyId(ACCESS_KEY_ID);
        clientOptions.setAccessKeySecret(ACCESS_KEY_SECRET);
        // If you are a private deployment customer, you need to set the GenAuth service domain name
        // clientOptions.setHost("https://api.your-authing-service.com");

        ManagementClient client = new ManagementClient(clientOptions);

        HasAnyRoleReqDto reqDto = new HasAnyRoleReqDto();
        reqDto.setUserId("6229ffaxxxxxxxxcade3e3d9");
        List<HasRoleRolesDto> list = new ArrayList<>();
        HasRoleRolesDto rolesDto = new HasRoleRolesDto();
        rolesDto.setCode("xxx");
        rolesDto.setNamespace("xxx");
        list.add(rolesDto);
        reqDto.setRoles(list);
        HasAnyRoleRespDto response = client.hasAnyRole(reqDto);
        System.out.println(JsonUtils.serialize(response));
    }
}

Request Response

Type： HasAnyRoleRespDto

NameTypeDescription
statusCodenumberBusiness status code. You can use this status code to determine whether the operation is successful. 200 means success.
messagestringDescription
apiCodenumberSegment error code, through which the specific error type can be obtained (not returned for successful requests). For a detailed list of error codes, see：API Code List (opens new window)
requestIdstringRequest ID. Returned when the request fails.
dataHasAnyRoleDtoResponse data

Example Results：

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "hasAnyRole": true
  }
}

Data Structure

HasRoleRolesDto

NameType
Is it required
Description
Example Value
namespacestringNoCode of the permission group (permission space). Do not pass it to get the default permission group.default
codestringYesRole codeadmin

HasAnyRoleOptionsDto

NameType
Is it required
Description
Example Value
userIdTypestringNoUser id type, the default value is user_id, the optional values ​​are:
- user_id: GenAuth user ID, such as 6319a1504f3xxxxf214dd5b7
- phone: user phone number
- email: user email
- username: username
- external_id: user ID in the external system, corresponding to the externalId field of GenAuth user information
- identity: user's external identity source information, the format is <extIdpId>:<userIdInIdp>, where <extIdpId> is the ID of the GenAuth identity source, and <userIdInIdp> is the user's ID in the external identity source.
Example Value: 62f20932716fbcc10d966ee5:ou_8bae746eac07cd2564654140d2a9ac61.
- sync_relation: The user's external identity source information, in the format of <provier>:<userIdInIdp>, where <provier> is the synchronization identity source type, such as wechatwork, lark; <userIdInIdp> is the user's ID in the external identity source.
Example Value: lark:ou_8bae746eac07cd2564654140d2a9ac61.
user_id

HasAnyRoleDto

NameType
Is it required
Description
Example Value
hasAnyRolebooleanYesYes No Has any of the rolestrue