bm admin user info

Syntax

The bm admin user info command returns detailed information of a Buckit user on the target Buckit deployment.

To manage external Identity Provider users, see OIDC or AD/LDAP.

The following command returns details of user myuser on the mybuckit Buckit deployment:

bm admin user info mybuckit myuser

The command has the following syntax:

bm [GLOBALFLAGS] admin user info      \
                            ALIAS     \
                            USERNAME
  • Brackets [] indicate optional parameters.

  • Parameters sharing a line are mutually dependent.

  • Parameters separated using the pipe | operator are mutually exclusive.

Copy the example to a text editor and modify as-needed before running the command in the terminal/shell.

Parameters

ALIAS
Required

The alias of a configured Buckit deployment to retrieve user information from.

USERNAME

The username to retrieve information for.

Global Flags

This command supports any of the global flags.

Examples

View User Details

Use bm admin user info to view detailed user information for a user on a Buckit deployment:

bm admin user info ALIAS USERNAME
  • Replace ALIAS with the alias of the Buckit deployment.

  • Replace USERNAME with the username of the user to display information for.

For the Buckit internal IDentity Provider (IDP), the output resembles the following:

AccessKey: miniouser
Status: enabled
PolicyName:
MemberOf: []
Authentication: builtin (miniouser)

For a third-party identity service such as LDAP, the output resembles the following:

AccessKey: uid=dillon,ou=people,ou=swengg,dc=min,dc=io
Status:
PolicyName: consoleAdmin
MemberOf: []
Authentication: ldap/localhost:1389 (uid=dillon,ou=people,ou=swengg,dc=min,dc=io)

View Policies from Group Membership

Use bm admin user info with --json to view the policies inherited from a user’s group memberships:

bm admin user info ALIAS USERNAME --json
  • Replace ALIAS with the alias of the Buckit deployment.

  • Replace USERNAME with the username of the user to display information for.

The memberOf property in the output contains a list of groups the user is a member of, with the policies attached to each group. The output resembles the following:

{
 "status": "success",
 "accessKey": "myuser",
 "userStatus": "enabled",
 "memberOf": [
  {
   "name": "testingGroup",
   "policies": [
    "testingGroupPolicy"
   ]
 "authentication": builtin (myuser)
  }
 ]
}

Behavior

S3 Compatibility

The bm commandline tool is built for compatibility with the AWS S3 API and is tested with Buckit and AWS S3 for expected functionality and behavior.

Buckit provides no guarantees for other S3-compatible services, as their S3 API implementation is unknown and therefore unsupported. While bm commands may work as documented, any such usage is at your own risk.