List Access Group Members

List all members of a group.

Options

Field Definition Type Required

Result Set

Choose a method to filter search results:

  • First Matching Record: Returns the first record that matches.

  • First 100 Matching Records: Returns the first 100 matching records.

  • Stream Matching Records: Passes all matching records from your parent flow to a helper flow.

    Selecting this option adds a Streaming input section to the card where you can select a helper flow for streaming and add custom extensible fields.

Dropdown FALSE

Input

Field Definition Type Required

Group

Access Group ID

The unique identifier of the access group.

Text TRUE

Membership Type

The type of membership of the users:

  • Static

  • Dynamic

  • All

Dropdown FALSE

Type

The member type:

  • User

  • Service ID

  • Trusted Profile

Dropdown FALSE

Sort

Sort the results by:

  • ID

  • Name

  • Email

Dropdown FALSE

Transaction

ID

An ID that can be used for tracking calls through multiple services.

Adding a transaction ID to your request is useful for tracking calls through multiple services with a single identifier. To do this, add a header with the key "transaction ID" and set its value to whatever you want. If you don't provide your own ID, the application automatically creates a random one for you.

 Text FALSE

Streaming

Flow

Click Choose Flow to select a helper flow. Search results will be streamed to this flow. Then, click Choose to confirm.

Optionally, add custom fields to pass data to the helper flow. Click the empty field under Click or drop here to create these fields. They appear as key/value pairs in the helper flow's State output object.

This option is available only when you select Stream Matching Records from the Result Set option.

In the helper flow, the input field on the helper card must reference a State Record key to get the streamed records. To get your custom input values, reference the State key within the State object.

TRUE

Record Limit

Specify the number of records to stream.

  • The Record Limit field can't be set to 0. When the Record Limit field is set to greater than 1, the stream returns up to the maximum number specified.
  • When the Record Limit field is null or not selected, the stream returns all records.
  • The default value is 500000.
  • The valid range is from 1 to 500000.

This field appears when you select Stream Matching Records from the Result Set option.

 Number FALSE

Output

Field Definition Type

Transaction

ID

An ID that can be used for tracking calls through multiple services.

Text

Result

Total Count

The total number of records.

Number

Members

An object containing information about the member. List of Objects

IAM ID

A unique identifier of the IBM cloud account. It can be IBMid, service ID, or trusted profile ID.

 Text

Type

The member type:

  • User

  • Service ID

  • Trusted Profile

Text

Membership Type

The type of membership of the users:

  • Static

  • Dynamic

Text

Name

The name of the user or service ID.

Text

Email

If the member type is user, this is the user's email.

Text

Description

If the member type is service, this is the service ID's description.

Text

Created At

The timestamp of when the membership was created.

 Date & Time

Created By

The iam_id of the entity that created the membership.

Text

Href

The URL of the given member resource.

Text

Records Streamed

Number of records streamed in a streaming flow.

This field appears when you select Stream Matching Records from the Result Set option.

 Number