Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListIdentityProviders

Lists the Active Directory identity providers for user-based subscriptions.

Request Syntax


POST /identity-provider/ListIdentityProviders HTTP/1.1
Content-type: application/json

{
   "Filters": [ 
      { 
         "Attribute": "string",
         "Operation": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Filters

You can use the following filters to streamline results:

Product
DirectoryId

Type: Array of Filter objects

Required: No

MaxResults

The maximum number of results to return from a single request.

Type: Integer

Required: No

NextToken

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

Type: String

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "IdentityProviderSummaries": [ 
      { 
         "FailureMessage": "string",
         "IdentityProvider": { ... },
         "IdentityProviderArn": "string",
         "Product": "string",
         "Settings": { 
            "SecurityGroupId": "string",
            "Subnets": [ "string" ]
         },
         "Status": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

IdentityProviderSummaries

An array of IdentityProviderSummary resources that contain details about the Active Directory identity providers that meet the request criteria.

Type: Array of IdentityProviderSummary objects

NextToken

The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient access to perform this action.

HTTP Status Code: 400

ConflictException

The request couldn't be completed because it conflicted with the current state of the resource.

HTTP Status Code: 500

InternalServerException

An exception occurred with the service.

HTTP Status Code: 500

ResourceNotFoundException

The resource couldn't be found.

HTTP Status Code: 404

ServiceQuotaExceededException

The request failed because a service quota is exceeded.

HTTP Status Code: 400

ThrottlingException

The request was denied because of request throttling. Retry the request.

HTTP Status Code: 400

ValidationException

A parameter is not valid.

HTTP Status Code: 400