List Identity Sources

verifiedpermissions_list_identity_sources

R Documentation

Returns a paginated list of all of the identity sources defined in the specified policy store

Description

Returns a paginated list of all of the identity sources defined in the specified policy store.

Usage

verifiedpermissions_list_identity_sources(policyStoreId, nextToken,
  maxResults, filters)

Arguments

policyStoreId

[required] Specifies the ID of the policy store that contains the identity sources that you want to list.

nextToken

Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

maxResults

Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

If you do not specify this parameter, the operation defaults to 10 identity sources per response. You can specify a maximum of 50 identity sources per response.

filters

Specifies characteristics of an identity source that you can use to limit the output to matching identity sources.

Value

A list with the following syntax:

list(
  nextToken = "string",
  identitySources = list(
    list(
      createdDate = as.POSIXct(
        "2015-01-01"
      ),
      details = list(
        clientIds = list(
          "string"
        ),
        userPoolArn = "string",
        discoveryUrl = "string",
        openIdIssuer = "COGNITO"
      ),
      identitySourceId = "string",
      lastUpdatedDate = as.POSIXct(
        "2015-01-01"
      ),
      policyStoreId = "string",
      principalEntityType = "string",
      configuration = list(
        cognitoUserPoolConfiguration = list(
          userPoolArn = "string",
          clientIds = list(
            "string"
          ),
          issuer = "string",
          groupConfiguration = list(
            groupEntityType = "string"
          )
        ),
        openIdConnectConfiguration = list(
          issuer = "string",
          entityIdPrefix = "string",
          groupConfiguration = list(
            groupClaim = "string",
            groupEntityType = "string"
          ),
          tokenSelection = list(
            accessTokenOnly = list(
              principalIdClaim = "string",
              audiences = list(
                "string"
              )
            ),
            identityTokenOnly = list(
              principalIdClaim = "string",
              clientIds = list(
                "string"
              )
            )
          )
        )
      )
    )
  )
)

Request syntax

svc$list_identity_sources(
  policyStoreId = "string",
  nextToken = "string",
  maxResults = 123,
  filters = list(
    list(
      principalEntityType = "string"
    )
  )
)