Documentation ¶
Overview ¶
Package identitystore provides the API client, operations, and parameter types for AWS SSO Identity Store.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- type Client
- func (c *Client) DescribeGroup(ctx context.Context, params *DescribeGroupInput, optFns ...func(*Options)) (*DescribeGroupOutput, error)
- func (c *Client) DescribeUser(ctx context.Context, params *DescribeUserInput, optFns ...func(*Options)) (*DescribeUserOutput, error)
- func (c *Client) ListGroups(ctx context.Context, params *ListGroupsInput, optFns ...func(*Options)) (*ListGroupsOutput, error)
- func (c *Client) ListUsers(ctx context.Context, params *ListUsersInput, optFns ...func(*Options)) (*ListUsersOutput, error)
- type DescribeGroupInput
- type DescribeGroupOutput
- type DescribeUserInput
- type DescribeUserOutput
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type HTTPClient
- type HTTPSignerV4
- type ListGroupsInput
- type ListGroupsOutput
- type ListUsersInput
- type ListUsersOutput
- type Options
- type ResolveEndpoint
Constants ¶
const ServiceAPIVersion = "2020-06-15"
const ServiceID = "identitystore"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for AWS SSO Identity Store.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) DescribeGroup ¶
func (c *Client) DescribeGroup(ctx context.Context, params *DescribeGroupInput, optFns ...func(*Options)) (*DescribeGroupOutput, error)
Retrieves the group metadata and attributes from GroupId in an identity store.
func (*Client) DescribeUser ¶
func (c *Client) DescribeUser(ctx context.Context, params *DescribeUserInput, optFns ...func(*Options)) (*DescribeUserOutput, error)
Retrieves the user metadata and attributes from UserId in an identity store.
func (*Client) ListGroups ¶
func (c *Client) ListGroups(ctx context.Context, params *ListGroupsInput, optFns ...func(*Options)) (*ListGroupsOutput, error)
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.
func (*Client) ListUsers ¶
func (c *Client) ListUsers(ctx context.Context, params *ListUsersInput, optFns ...func(*Options)) (*ListUsersOutput, error)
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.
type DescribeGroupInput ¶
type DescribeGroupInput struct { // The identifier for a group in the identity store. // // This member is required. GroupId *string // 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 which contains number and lower case letters. This value is generated at // the time that a new identity store is created. // // This member is required. IdentityStoreId *string }
type DescribeGroupOutput ¶
type DescribeGroupOutput struct { // Contains the group’s display name value. The length limit is 1024 characters. // This value can consist of letters, accented characters, symbols, numbers, // punctuation, tab, new line, carriage return, space and non breaking 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. // // This member is required. DisplayName *string // The identifier for a group in the identity store. // // This member is required. GroupId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeUserInput ¶
type DescribeUserInput struct { // 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 which contains number and lower case letters. This value is generated at // the time that a new identity store is created. // // This member is required. IdentityStoreId *string // The identifier for a user in the identity store. // // This member is required. UserId *string }
type DescribeUserOutput ¶
type DescribeUserOutput struct { // The identifier for a user in the identity store. // // This member is required. UserId *string // Contains the user’s username 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. // // This member is required. UserName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func WithEndpointResolver ¶
func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver
WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type HTTPSignerV4 ¶
type ListGroupsInput ¶
type ListGroupsInput struct { // 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 which contains number and lower case letters. This value is generated at // the time that a new identity store is created. // // This member is required. IdentityStoreId *string // A list of Filter objects, which is used in the ListUsers and ListGroups request. Filters []*types.Filter // The maximum number of results to be returned per request, which is used in the // ListUsers and ListGroups request to specify how many results to return in one // page. The length limit is 50 characters. MaxResults *int32 // The pagination token used for the ListUsers and ListGroups APIs. This value is // generated by the identity store service and is returned in the API response if // the total results are more than the size of one page, and when this token is // used in the API request to search for the next page. NextToken *string }
type ListGroupsOutput ¶
type ListGroupsOutput struct { // A list of Group objects in the identity store. // // This member is required. Groups []*types.Group // The pagination token used for the ListUsers and ListGroups APIs. This value is // generated by the identity store service and is returned in the API response if // the total results are more than the size of one page, and when this token is // used in the API request to search for the next page. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListUsersInput ¶
type ListUsersInput struct { // 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 which contains number and lower case letters. This value is generated at // the time that a new identity store is created. // // This member is required. IdentityStoreId *string // A list of Filter objects, which is used in the ListUsers and ListGroups request. Filters []*types.Filter // The maximum number of results to be returned per request, which is used in the // ListUsers and ListGroups request to specify how many results to return in one // page. The length limit is 50 characters. MaxResults *int32 // The pagination token used for the ListUsers and ListGroups APIs. This value is // generated by the identity store service and is returned in the API response if // the total results are more than the size of one page, and when this token is // used in the API request to search for the next page. NextToken *string }
type ListUsersOutput ¶
type ListUsersOutput struct { // A list of User objects in the identity store. // // This member is required. Users []*types.User // The pagination token used for the ListUsers and ListGroups APIs. This value is // generated by the identity store service and is returned in the API response if // the total results are more than the size of one page, and when this token is // used in the API request to search for the next page. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer retry.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string