Determine whether the user has a certain role

This document is automatically generated based on https://github.com/authing/authing-docs-factory based on 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.

Use user ID to determine whether the user has a certain role. Supports passing in multiple roles, and can choose to specify the user ID type, etc.

Method Name

ManagementClient.hasAnyRole

Request Parameters

Name	Type	Is it required?	Default value	Description	Sample value
roles	<a HasRoleRolesDto[]	yes	-	Role list
userId	string	yes	-	The unique identifier of the user, which can be 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
options	<a HasAnyRoleOptionsDto	no	-	Optional parameters

Example Code

import { ManagementClient, Models } from "authing-node-sdk";

// Initialize ManagementClient
const managementClient = new ManagementClient({
  // Need to be replaced with your GenAuth Access Key ID
  accessKeyId: "GEN_AUTH_ACCESS_KEY_ID",
  // Need to be replaced with your GenAuth Access Key Secret
  accessKeySecret: "GEN_AUTH_ACCESS_KEY_SECRET",
  // If it is a private deployment customer, you need to set the GenAuth service domain name
  // host: 'https://api.your-authing-service.com'
});

(async () => {
  const result = await managementClient.hasAnyRole({
    // Replace user ID
    userId: "6229ffaxxxxxxxxcade3e3d9",
    roles: [
      {
        namespace: "default",
        code: "admin",
      },
    ],
    options: {
      userIdType: Models.HasAnyRoleOptionsDto.userIdType.USER_ID,
    },
  });
  console.log(JSON.stringify(result, null, 2));
})();

Request Response

type: HasAnyRoleRespDto

Name	Type	Description
statusCode	number	Business status code, which can be used to determine whether the operation is successful. 200 means success.
message	string	Description
apiCode	number	Segmented error code, which can be used to get the specific error type (successful requests are not returned). For a detailed list of error codes, see: API Code List
requestId	string	Request ID. Returned when the request fails.
data	<a HasAnyRoleDto	Response data

Sample result:

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

Data Structure

HasRoleRolesDto

Name	Type	Is it required	Description	Example value
namespace	string	No	Code of the permission group (permission space). Do not pass to obtain the default permission group.	default
code	string	Yes	Role code	admin

HasAnyRoleOptionsDto

Name	Type	Is it required	Description	Sample value
userIdType	string	No	User 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, in the format of <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

Name	Type	Is it required?	Description	Sample value
hasAnyRole	boolean	Yes	Does it have any of the roles?	true