Table Of Contents

  1. Docs
  2. Available services
  3. IdentityStore

IdentityStore

Table of Contents

Client

class IdentityStore.Client

A low-level client representing AWS SSO Identity Store (IdentityStore)

The AWS Single Sign-On (SSO) Identity Store service provides a single place to retrieve all of your identities (users and groups). For more information about AWS, see the AWS Single Sign-On User Guide .

import boto3

client = boto3.client('identitystore')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
close()

Closes underlying endpoint connections.

describe_group(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_group(
    IdentityStoreId='string',
    GroupId='string'
)
Parameters
  • IdentityStoreId (string) --

    [REQUIRED]

    The globally unique identifier for the identity store, such as d-1234567890 . In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains number and lower case letters. This value is generated at the time that a new identity store is created.

  • GroupId (string) --

    [REQUIRED]

    The identifier for a group in the identity store.

Return type

dict

Returns

Response Syntax

{
    'GroupId': 'string',
    'DisplayName': 'string'
}

Response Structure

  • (dict) --

    • GroupId (string) --

      The identifier for a group in the identity store.

    • DisplayName (string) --

      Contains the group’s display name value. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. The characters <>;:% are excluded. This value is specified at the time that the group is created and stored as an attribute of the group object in the identity store.

Exceptions

  • IdentityStore.Client.exceptions.ResourceNotFoundException
  • IdentityStore.Client.exceptions.ValidationException
  • IdentityStore.Client.exceptions.AccessDeniedException
  • IdentityStore.Client.exceptions.ThrottlingException
  • IdentityStore.Client.exceptions.InternalServerException
describe_user(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_user(
    IdentityStoreId='string',
    UserId='string'
)
Parameters
  • IdentityStoreId (string) --

    [REQUIRED]

    The globally unique identifier for the identity store, such as d-1234567890 . In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains number and lower case letters. This value is generated at the time that a new identity store is created.

  • UserId (string) --

    [REQUIRED]

    The identifier for a user in the identity store.

Return type

dict

Returns

Response Syntax

{
    'UserName': 'string',
    'UserId': 'string'
}

Response Structure

  • (dict) --

    • UserName (string) --

      Contains the user’s user name value. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. The characters <>;:% are excluded. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

    • UserId (string) --

      The identifier for a user in the identity store.

Exceptions

  • IdentityStore.Client.exceptions.ResourceNotFoundException
  • IdentityStore.Client.exceptions.ValidationException
  • IdentityStore.Client.exceptions.AccessDeniedException
  • IdentityStore.Client.exceptions.ThrottlingException
  • IdentityStore.Client.exceptions.InternalServerException
get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_groups(**kwargs)

Lists the attribute name and value of the group that you specified in the search. We only support DisplayName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including GroupId and group DisplayName in the response.

See also: AWS API Documentation

Request Syntax

response = client.list_groups(
    IdentityStoreId='string',
    MaxResults=123,
    NextToken='string',
    Filters=[
        {
            'AttributePath': 'string',
            'AttributeValue': 'string'
        },
    ]
)
Parameters
  • IdentityStoreId (string) --

    [REQUIRED]

    The globally unique identifier for the identity store, such as d-1234567890 . In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains number and lower case letters. This value is generated at the time that a new identity store is created.

  • MaxResults (integer) -- The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups request to specify how many results to return in one page. The length limit is 50 characters.
  • NextToken (string) -- The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.
  • Filters (list) --

    A list of Filter objects, which is used in the ListUsers and ListGroups request.

    • (dict) --

      A query filter used by ListUsers and ListGroup . This filter object provides the attribute name and attribute value to search users or groups.

      • AttributePath (string) -- [REQUIRED]

        The attribute path that is used to specify which attribute name to search. Length limit is 255 characters. For example, UserName is a valid attribute path for the ListUsers API, and DisplayName is a valid attribute path for the ListGroups API.

      • AttributeValue (string) -- [REQUIRED]

        Represents the data for an attribute. Each attribute value is described as a name-value pair.

Return type

dict

Returns

Response Syntax

{
    'Groups': [
        {
            'GroupId': 'string',
            'DisplayName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Groups (list) --

      A list of Group objects in the identity store.

      • (dict) --

        A group object, which contains a specified group’s metadata and attributes.

        • GroupId (string) --

          The identifier for a group in the identity store.

        • DisplayName (string) --

          Contains the group’s display name value. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. The characters <>;:% are excluded. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.

    • NextToken (string) --

      The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it1 is used in the API request to search for the next page.

Exceptions

  • IdentityStore.Client.exceptions.ValidationException
  • IdentityStore.Client.exceptions.AccessDeniedException
  • IdentityStore.Client.exceptions.ResourceNotFoundException
  • IdentityStore.Client.exceptions.ThrottlingException
  • IdentityStore.Client.exceptions.InternalServerException
list_users(**kwargs)

Lists the attribute name and value of the user that you specified in the search. We only support UserName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including UserId and UserName in the response.

See also: AWS API Documentation

Request Syntax

response = client.list_users(
    IdentityStoreId='string',
    MaxResults=123,
    NextToken='string',
    Filters=[
        {
            'AttributePath': 'string',
            'AttributeValue': 'string'
        },
    ]
)
Parameters
  • IdentityStoreId (string) --

    [REQUIRED]

    The globally unique identifier for the identity store, such as d-1234567890 . In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains number and lower case letters. This value is generated at the time that a new identity store is created.

  • MaxResults (integer) -- The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups request to specify how many results to return in one page. The length limit is 50 characters.
  • NextToken (string) -- The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.
  • Filters (list) --

    A list of Filter objects, which is used in the ListUsers and ListGroups request.

    • (dict) --

      A query filter used by ListUsers and ListGroup . This filter object provides the attribute name and attribute value to search users or groups.

      • AttributePath (string) -- [REQUIRED]

        The attribute path that is used to specify which attribute name to search. Length limit is 255 characters. For example, UserName is a valid attribute path for the ListUsers API, and DisplayName is a valid attribute path for the ListGroups API.

      • AttributeValue (string) -- [REQUIRED]

        Represents the data for an attribute. Each attribute value is described as a name-value pair.

Return type

dict

Returns

Response Syntax

{
    'Users': [
        {
            'UserName': 'string',
            'UserId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Users (list) --

      A list of User objects in the identity store.

      • (dict) --

        A user object, which contains a specified user’s metadata and attributes.

        • UserName (string) --

          Contains the user’s user name value. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. The characters <>;:% are excluded. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

        • UserId (string) --

          The identifier for a user in the identity store.

    • NextToken (string) --

      The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

Exceptions

  • IdentityStore.Client.exceptions.ValidationException
  • IdentityStore.Client.exceptions.AccessDeniedException
  • IdentityStore.Client.exceptions.ResourceNotFoundException
  • IdentityStore.Client.exceptions.ThrottlingException
  • IdentityStore.Client.exceptions.InternalServerException

Paginators

The available paginators are:

IAM
imagebuilder
Privacy | Site Terms | Cookie preferences | © Copyright 2022, Amazon Web Services, Inc. Created using Sphinx.