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.deno.dev/v0.4/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)
[src]

§Methods

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

Creates a group within the specified identity store.

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

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>
[src]

Creates a new user within the specified identity store.

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

Delete a group within an identity store given GroupId.

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

Delete a membership within a group given MembershipId.

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

Deletes a user within an identity store given UserId.

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

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

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

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

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

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

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

Retrieves GroupId in an identity store.

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

Retrieves the MembershipId in an identity store.

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

Retrieves the UserId in an identity store.

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

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

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

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

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

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

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

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.

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

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.

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

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

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

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

§Static Properties