Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@datafire/amazonaws_identitystore

DataFire2MIT5.0.0

DataFire integration for AWS SSO Identity Store

readme

@datafire/amazonaws_identitystore

Client library for AWS SSO Identity Store

Installation and Usage

npm install --save @datafire/amazonaws_identitystore
let amazonaws_identitystore = require('@datafire/amazonaws_identitystore').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Actions

DescribeGroup

amazonaws_identitystore.DescribeGroup({
  "IdentityStoreId": null,
  "GroupId": null
}, context)

Input

  • input object
    • GroupId required
    • IdentityStoreId required

Output

DescribeUser

amazonaws_identitystore.DescribeUser({
  "IdentityStoreId": null,
  "UserId": null
}, context)

Input

  • input object
    • IdentityStoreId required
    • UserId required

Output

ListGroups

amazonaws_identitystore.ListGroups({
  "IdentityStoreId": null
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • Filters
    • IdentityStoreId required
    • MaxResults
    • NextToken

Output

ListUsers

amazonaws_identitystore.ListUsers({
  "IdentityStoreId": null
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • Filters
    • IdentityStoreId required
    • MaxResults
    • NextToken

Output

Definitions

AccessDeniedException

AttributePath

  • AttributePath string

DescribeGroupRequest

  • DescribeGroupRequest object
    • GroupId required
    • IdentityStoreId required

DescribeGroupResponse

  • DescribeGroupResponse object
    • DisplayName required
    • GroupId required

DescribeUserRequest

  • DescribeUserRequest object
    • IdentityStoreId required
    • UserId required

DescribeUserResponse

  • DescribeUserResponse object
    • UserId required
    • UserName required

Filter

  • Filter object: A query filter used by ListUsers and ListGroup. This filter object provides the attribute name and attribute value to search users or groups.
    • AttributePath required
    • AttributeValue required

Filters

Group

  • Group object: A group object, which contains a specified group’s metadata and attributes.
    • DisplayName required
    • GroupId required

GroupDisplayName

  • GroupDisplayName string

Groups

  • Groups array

IdentityStoreId

  • IdentityStoreId string

InternalServerException

ListGroupsRequest

  • ListGroupsRequest object
    • Filters
    • IdentityStoreId required
    • MaxResults
    • NextToken

ListGroupsResponse

  • ListGroupsResponse object
    • Groups required
    • NextToken

ListUsersRequest

  • ListUsersRequest object
    • Filters
    • IdentityStoreId required
    • MaxResults
    • NextToken

ListUsersResponse

  • ListUsersResponse object
    • NextToken
    • Users required

MaxResults

  • MaxResults integer

NextToken

  • NextToken string

ResourceId

  • ResourceId string

ResourceNotFoundException

SensitiveStringType

  • SensitiveStringType string

ThrottlingException

User

  • User object: A user object, which contains a specified user’s metadata and attributes.
    • UserId required
    • UserName required

UserName

  • UserName string

Users

  • Users array

ValidationException