bm idp ldap policy entities

Description

The bm idp ldap policy entities command displays a list of mappings for a user, group, and/or policy.

The following example lists all mappings for a specific policy, a set of groups, and a selection of users on the mybuckit deployment.

Specifically, it lists:

  • Users mapped to the finteam-policy policy.

  • Policies assigned to the uid=bobfisher,ou=people,ou=hwengg,dc=min,dc=io user.

  • Policies assigned to the cn=projectb,ou=groups,ou=swengg,dc=min,dc=io group.

bm idp ldap policy entities mybuckit                                                  \
                            --policy finteam-policy                                  \
                            --user 'uid=bobfisher,ou=people,ou=hwengg,dc=min,dc=io'  \
                            --group 'cn=projectb,ou=groups,ou=swengg,dc=min,dc=io'

The command has the following syntax:

bm [GLOBALFLAGS] idp ldap policy entities                       \
                                 ALIAS                          \
                                 [--group `value`, -g `value`]  \
                                 [--policy value]               \
                                 [--user `value`, -u `value`]
  • Replace ALIAS with the alias of a Buckit deployment to configure for AD/LDAP integration.

  • You may use each of the --user, --group, and/or --policy flags as many times as desired in the command.

  • For each flag, the output lists the entities mapped to the specified policy, user, or group.

  • Omit all flags to return a list of mappings for all policies.

  • 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 for which to display the entity mappings.

For example:

bm idp ldap policy entities mybuckit
--group
Optional

Returns a list of users and policies associated with the specified group. Repeat the flag to return a list for multiple groups.

--policies
Optional

Returns a list of users and groups associated with the specified policy. Repeat the flag to return a list for multiple policies.

--user
Optional

Returns a list of groups to which the user belongs and the policies associated with each group. The output includes only groups assigned to policies.

Repeat the flag to return a list for multiple users.

Example

The following example lists the entities mapped to each of two policies, policy1 and policy2 and entities mapped to the projectb group on the mybuckit deployment:

bm idp ldap policy entities mybuckit                                                 \
                          policy1                                                 \
                          policy2                                                 \
                          --group='cn=projectb,ou=groups,ou=swengg,dc=min,dc=io'

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.