Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

IdentityStore

import { IdentityStore } from "https://aws-api-bqtgftz736ft.deno.dev/v0.5/services/identitystore.ts?docs=full";

class IdentityStore {

constructor(apiFactory: client.ApiFactory);

async createGroup(params: CreateGroupRequest, opts?: client.RequestOptions): Promise<CreateGroupResponse>;

async createGroupMembership(params: CreateGroupMembershipRequest, opts?: client.RequestOptions): Promise<CreateGroupMembershipResponse>;

async createUser(params: CreateUserRequest, opts?: client.RequestOptions): Promise<CreateUserResponse>;

async deleteGroup(params: DeleteGroupRequest, opts?: client.RequestOptions): Promise<void>;

async deleteGroupMembership(params: DeleteGroupMembershipRequest, opts?: client.RequestOptions): Promise<void>;

async deleteUser(params: DeleteUserRequest, opts?: client.RequestOptions): Promise<void>;

async describeGroup(params: DescribeGroupRequest, opts?: client.RequestOptions): Promise<DescribeGroupResponse>;

async describeGroupMembership(params: DescribeGroupMembershipRequest, opts?: client.RequestOptions): Promise<DescribeGroupMembershipResponse>;

async describeUser(params: DescribeUserRequest, opts?: client.RequestOptions): Promise<DescribeUserResponse>;

async getGroupId(params: GetGroupIdRequest, opts?: client.RequestOptions): Promise<GetGroupIdResponse>;

async getGroupMembershipId(params: GetGroupMembershipIdRequest, opts?: client.RequestOptions): Promise<GetGroupMembershipIdResponse>;

async getUserId(params: GetUserIdRequest, opts?: client.RequestOptions): Promise<GetUserIdResponse>;

async isMemberInGroups(params: IsMemberInGroupsRequest, opts?: client.RequestOptions): Promise<IsMemberInGroupsResponse>;

async listGroupMemberships(params: ListGroupMembershipsRequest, opts?: client.RequestOptions): Promise<ListGroupMembershipsResponse>;

async listGroupMembershipsForMember(params: ListGroupMembershipsForMemberRequest, opts?: client.RequestOptions): Promise<ListGroupMembershipsForMemberResponse>;

async listGroups(params: ListGroupsRequest, opts?: client.RequestOptions): Promise<ListGroupsResponse>;

async listUsers(params: ListUsersRequest, opts?: client.RequestOptions): Promise<ListUsersResponse>;

async updateGroup(params: UpdateGroupRequest, opts?: client.RequestOptions): Promise<void>;

async updateUser(params: UpdateUserRequest, opts?: client.RequestOptions): Promise<void>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new IdentityStore(apiFactory: client.ApiFactory)

§Methods

createGroup(params: CreateGroupRequest, opts?: client.RequestOptions): Promise<CreateGroupResponse>

Creates a group within the specified identity store.

createGroupMembership(params: CreateGroupMembershipRequest, opts?: client.RequestOptions): Promise<CreateGroupMembershipResponse>

Creates a relationship between a member and a group. The following identifiers must be specified: GroupId, IdentityStoreId, and MemberId.

createUser(params: CreateUserRequest, opts?: client.RequestOptions): Promise<CreateUserResponse>

Creates a user within the specified identity store.

deleteGroup(params: DeleteGroupRequest, opts?: client.RequestOptions): Promise<void>

Delete a group within an identity store given GroupId.

deleteGroupMembership(params: DeleteGroupMembershipRequest, opts?: client.RequestOptions): Promise<void>

Delete a membership within a group given MembershipId.

deleteUser(params: DeleteUserRequest, opts?: client.RequestOptions): Promise<void>

Deletes a user within an identity store given UserId.

describeGroup(params: DescribeGroupRequest, opts?: client.RequestOptions): Promise<DescribeGroupResponse>

Retrieves the group metadata and attributes from GroupId in an identity store.

Note: 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.

describeGroupMembership(params: DescribeGroupMembershipRequest, opts?: client.RequestOptions): Promise<DescribeGroupMembershipResponse>

Retrieves membership metadata and attributes from MembershipId in an identity store.

Note: 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.

describeUser(params: DescribeUserRequest, opts?: client.RequestOptions): Promise<DescribeUserResponse>

Retrieves the user metadata and attributes from the UserId in an identity store.

Note: 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.

getGroupId(params: GetGroupIdRequest, opts?: client.RequestOptions): Promise<GetGroupIdResponse>

Retrieves GroupId in an identity store.

Note: 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.

getGroupMembershipId(params: GetGroupMembershipIdRequest, opts?: client.RequestOptions): Promise<GetGroupMembershipIdResponse>

Retrieves the MembershipId in an identity store.

Note: 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.

getUserId(params: GetUserIdRequest, opts?: client.RequestOptions): Promise<GetUserIdResponse>

Retrieves the UserId in an identity store.

Note: 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.

isMemberInGroups(params: IsMemberInGroupsRequest, opts?: client.RequestOptions): Promise<IsMemberInGroupsResponse>

Checks the user's membership in all requested groups and returns if the member exists in all queried groups.

Note: 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.

listGroupMemberships(params: ListGroupMembershipsRequest, opts?: client.RequestOptions): Promise<ListGroupMembershipsResponse>

For the specified group in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.

Note: 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.

listGroupMembershipsForMember(params: ListGroupMembershipsForMemberRequest, opts?: client.RequestOptions): Promise<ListGroupMembershipsForMemberResponse>

For the specified member in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.

Note: 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.

listGroups(params: ListGroupsRequest, opts?: client.RequestOptions): Promise<ListGroupsResponse>

Lists all groups in the identity store. Returns a paginated list of complete Group objects. Filtering for a Group by the DisplayName attribute is deprecated. Instead, use the GetGroupId API action.

Note: 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.

listUsers(params: ListUsersRequest, opts?: client.RequestOptions): Promise<ListUsersResponse>

Lists all users in the identity store. Returns a paginated list of complete User objects. Filtering for a User by the UserName attribute is deprecated. Instead, use the GetUserId API action.

Note: 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.

updateGroup(params: UpdateGroupRequest, opts?: client.RequestOptions): Promise<void>

For the specified group in the specified identity store, updates the group metadata and attributes.

updateUser(params: UpdateUserRequest, opts?: client.RequestOptions): Promise<void>

For the specified user in the specified identity store, updates the user metadata and attributes.

§Static Properties

ApiMetadata: client.ApiMetadata