Adds a member to a Group Policy.

Adds a member to a group policy. The fields required in the request body depend on the type of security provider the member is in.

  • Adding a local user as a member of a group policy requires the following fields: group_policy_id, security_provider_id, and user_id. The field distinguished_name must not be present.
  • Adding an LDAP user requires the following fields: group_policy_id and security_provider_id. Either user_id or distinguished_name must be provided but not both.
  • Adding an LDAP group requires the following fields: group_policy_id, security_provider_id, and distinguished_name.
  • RADIUS, Kerberos, and SAML users require the following fields: group_policy_id, security_provider_id, and user_id. RADIUS users must log into the BeyondTrust product at least once and be provisioned with a user ID.
  • Adding a SAML group requires the following fields: group_policy_id, security_provider_id, and group_name. The group_name must be the name of an existing group.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
1 to 2147483647

Unique identifier for the group policy.

Body Params
integer
1 to 2147483647

The unique identifier assigned to a security provider.

string
1 to 1024

The distinguished name (DN) of the LDAP user, organizational unit (OU), or container. This attribute is only present for users and groups belonging to LDAP security providers.

string
1 to 64

The name of the SAML group. This attribute is only available for SAML groups, as determined by the security_provider_id.

integer
1 to 2147483647

The unique identifier of a local, LDAP, RADIUS, Kerberos, or SAML user.

Responses
201

Indicates that the Member was successfully added.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

©2003-2026 BeyondTrust Corporation. All Rights Reserved. Other trademarks identified on this page are owned by their respective owners. BeyondTrust is not a chartered bank or trust company, or depository institution. It is not authorized to accept deposits or trust accounts and is not licensed or regulated by any state or federal banking authority.