Search Access Groups

Search access groups within an account.

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

Member

IAM ID

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

 Text FALSE

Membership Type

The membership type of the member.

  • Static

  • Dynamic

  • All

Membership type must be specified with the IAM ID and must be either static, dynamic, or all:

  • If the membership type is static, members explicitly added to the group are shown.
  • If the membership type is dynamic, members accessing the access group at the moment through dynamic rules are shown.
  • If the membership type is all, both static and dynamic members are shown.
 Dropdown FALSE

Search Criteria

ID

Unique identifier of the group.

Text FALSE

Name

Name of the group.

Text FALSE

Description

The description of the access group.

Text 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.

You can't search access group data using a transaction ID.

 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.

Flow

 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

ID

Unique identifier of the group.

Text

Name

Name of the group.

Text

Description

The description of the group.

Text

Account ID

The account ID where the group was created.

Text

Created At

The timestamp of when the group was created.

Date & Time

Created By

The IAM ID of the entity that created the group.

Text

Last Modified At

The timestamp of when the group was last edited.

Date & Time

Last Modified By

The IAM of the entity that last modified the group name or description.

Text

Href

The URL of the given group resource.

Text

Federated Group Rules Exist

Rules for user authentication and cloud environments within IBM Cloud. This is set to true if rules exist for the group.

True/False

Cloud Resource Name

The Cloud Resource Name of the access group.

Text

Total Count

The total number of records.

Number

Groups

List of Objects

ID

Unique identifier of the group.

Text

Name

Name of the group.

Text

Description

The description of the group.

Text

Account ID

The account id where the group was created.

Text

Created At

The timestamp of when the group was created.

Date & Time

Created By

The IAM ID of the entity that created the group.

Text

Last Modified At

The timestamp of when the group was last edited.

Date & Time

Last Modified By

The IAM ID of the entity that last modified the group name or description.

Text

Href

The URL of the given group resource.

Text

Federated Group Rules Exist

Rules for user authentication and cloud environments within IBM Cloud. This is set to true if rules exist for the group.

True/False

Cloud Resource Name

The Cloud Resource Name of the access group.

Text

Records Streamed

The number of records streamed in a streaming flow.

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

 Number