bm idp ldap accesskey ls
Description
The bm idp ldap accesskey ls displays a list of LDAP access key pairs.
bm idp ldap accesskey ls is also known as bm idp ldap accesskey list.
This command works against access keys created by an AD/LDAP user after authenticating to Buckit.
Create AD/LDAP service accounts with the bm idp ldap accesskey create command.
Buckit supports using AssumeRoleWithLDAPIdentity to generate temporary access keys using the Security Token Service.
The following example returns a list of access keys associated with the authenticated user on the
buckitalias:
bm idp ldap accesskey ls buckit/
If the authenticated user has the admin:ListUsers permission, the example command returns a list of all users and their associated access keys.
The command has the following syntax:
bm [GLOBALFLAGS] idp ldap accesskey ls \
ALIAS \
[--all] \
[--self] \
[--svcacc-only] \
[--temp-only] \
[--users-only] \
[DN] ...
Replace
ALIASwith the alias of a Buckit deployment configured for AD/LDAP integration.Replace
DNwith the string of a user’s distinguished name. You may list multiple distinguished names by separating each with a space.
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 the Buckit deployment configured for AD/LDAP.
For example:
bm idp ldap accesskey ls buckit
- --svcacc-only
- Optional
Output only service account access keys.
Mutually exclusive with
--temp-only.
- --temp-only
- Optional
Output only temporary access keys.
Mutually exclusive with
--svcacc-only.
Examples
List All Access Keys
To return a list of all access keys, you must first authenticate as the admin user.
Once authenticated, the following command returns all AD/LDAP access keys on the buckit deployment.
bm idp ldap accesskey ls buckit
Note
If the user does not have the admin:ListUsers permission, the command returns a list of access keys for the authenticated user only.
List User Distinguished Names
To return a list of DNs for a deployment, you must first authenticate as a user with the admin:ListUsers permission.
Once authenticated, the following command outputs the AD/LDAP distinguished names on the buckit deployment.
bm idp ldap accesskey ls buckit --users-only
List Temporary Access Keys
To return a list of all temporary access keys for a deployment, you must first authenticate as a user with the admin:ListUsers permission.
Once authenticated, the following command outputs a list of distinguished names with their associated temporary access keys.
bm idp ldap accesskey ls buckit --temp-only
List a User’s Access Keys
The following command returns the AD/LDAP access keys for the user bobfisher on the buckit deployment.
bm idp ldap accesskey list buckit/ uid=bobfisher,dc=min,dc=io
List Access Keys for Multiple Users
The following command returns the AD/LDAP access keys for the users bobfisher and cody3 on the buckit deployment.
bm idp ldap accesskey list buckit/ uid=bobfisher,dc=min,dc=io uid=cody3,dc=min,dc=io
List Access Keys for Authenticated User
The following command returns the AD/LDAP access keys for the currently authenticated user on the buckit deployment.
bm idp ldap accesskey list buckit/
Note
If the authenticated user has the admin:ListUsers permission, the command returns a list of all users and access keys on the deployment.
Global Flags
This command supports any of the global flags.
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.
