GetGroupIdCommand

Suggest an Edit

Retrieves GroupId in an identity store.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts  in the Organizations User Guide.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { IdentitystoreClient, GetGroupIdCommand } from "@aws-sdk/client-identitystore"; // ES Modules import
// const { IdentitystoreClient, GetGroupIdCommand } = require("@aws-sdk/client-identitystore"); // CommonJS import
const client = new IdentitystoreClient(config);
const input = { // GetGroupIdRequest
  IdentityStoreId: "STRING_VALUE", // required
  AlternateIdentifier: { // AlternateIdentifier Union: only one key present
    ExternalId: { // ExternalId
      Issuer: "STRING_VALUE", // required
      Id: "STRING_VALUE", // required
    },
    UniqueAttribute: { // UniqueAttribute
      AttributePath: "STRING_VALUE", // required
      AttributeValue: "DOCUMENT_VALUE", // required
    },
  },
};
const command = new GetGroupIdCommand(input);
const response = await client.send(command);
// { // GetGroupIdResponse
//   GroupId: "STRING_VALUE", // required
//   IdentityStoreId: "STRING_VALUE", // required
// };

GetGroupIdCommand Input

See GetGroupIdCommandInput for more details

Parameter
Type
Description
AlternateIdentifier
Required
AlternateIdentifier | undefined

A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For the unique attribute, the only valid path is displayName.

IdentityStoreId
Required
string | undefined

The globally unique identifier for the identity store.

GetGroupIdCommand Output

See GetGroupIdCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
GroupId
Required
string | undefined

The identifier for a group in the identity store.

IdentityStoreId
Required
string | undefined

The globally unique identifier for the identity store.

Throws

Name
Fault
Details
ResourceNotFoundException
client

Indicates that a requested resource is not found.

ValidationException
client

The request failed because it contains a syntax error.

AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

The request processing has failed because of an unknown error, exception or failure with an internal server.

ThrottlingException
client

Indicates that the principal has crossed the throttling limits of the API operations.

IdentitystoreServiceException
Base exception class for all service exceptions from Identitystore service.