Authing Docs

# Manage Roles

This module is used to manage Authing roles, and can perform operations such as adding, deleting, modifying, and checking roles, adding/deleting users, and adding/deleting roles.

# Creating a Role

RolesManagementClient().create(code, description)

Create role

# Parameters

  • code <string> unique character identifier
  • description <string> description

# Example

$role = $managementClient->roles()->create("code");

# Delete role

RolesManagementClient().delete(code)

Delete role

# Parameters

  • code <string> unique character identifier

# Example

$message = $managementClient->roles()->delete("code");

# Delete roles in batch

RolesManagementClient().deleteMany(codeList)

Batch delete roles

# Parameters

  • codeList <string[]> Character unique identifier list

# Example

$message = $managementClient->roles()->deleteMany(["code"]);

# Modify role

RolesManagementClient().update(code, input)

Modify role

# Parameters

  • code <string> unique character identifier
  • input <Object>
  • input.description <string> description information
  • input.newCode <string> New unique identifier

# Example

$role = $managementClient->roles()->update("code", "desc");

# Get role details

RolesManagementClient().detail(code)

Get role details

# Parameters

  • code <string> unique character identifier

# Example

$role = $managementClient->roles()->detail("code");

# Get a list of roles

RolesManagementClient().list(page, limit)

Get a list of roles

# Parameters

  • page <number> Page number The default value is: 1.
  • limit <number> Number per page The default value is 10.

# Example

$roles = $managementClient->roles()->paginate();

# Get the list of role users

RolesManagementClient().listUsers(code)

Get the list of role users

# Parameters

  • code <string> unique character identifier

# Example

$users = $managementClient->roles()->listUsers("code");

# Add user

RolesManagementClient().addUsers(code, userIds)

Add user

# Parameters

  • code <string> unique character identifier
  • userIds <string[]> list of user IDs

# Example

$message = $managementClient->roles()->addUsers("code", ["userId"]);

# Remove user

RolesManagementClient().removeUsers(code, userIds)

Remove user

# Parameters

  • code <string> unique character identifier
  • userIds <string[]> list of user IDs

# Example

$message = $managementClient->roles()->removeUsers("code", ["userId"]);

# Get a list of role policies

RolesManagementClient().listPolicies(code, page, limit)

Get a list of role policies

# Parameters

  • code <string> unique character identifier
  • page <number> Page number The default value is: 1.
  • limit <number> Number of page numbers The default value is 10.

# Example

$policies = $managementClient->roles()->listPolicies("code");

# Authorization Policy

RolesManagementClient().addPolicies(code, policies)

Grant role authorization strategy

# Parameters

  • code <string> unique character identifier
  • policies <string[]> policy list

# Example

$message = $managementClient->roles()->addPolicies("code", ["policy id"]);

# Role removal strategy

RolesManagementClient().removePolicies(code, policies)

Role removal strategy

# Parameters

  • code <string> unique character identifier
  • policies <string[]> policy list

# Example

$message = $managementClient->roles()->removePolicies("code", ["policy id"]);

← Manage Authority & Access Control →