Get Oauth 2 Credential Provider

bedrockagentcorecontrol_get_oauth_2_credential_provider

R Documentation

Retrieves information about an OAuth2 credential provider

Description

Retrieves information about an OAuth2 credential provider.

Usage

bedrockagentcorecontrol_get_oauth_2_credential_provider(name)

Arguments

name	[required] The name of the OAuth2 credential provider to retrieve.

Value

A list with the following syntax:

list(
  clientSecretArn = list(
    secretArn = "string"
  ),
  name = "string",
  credentialProviderArn = "string",
  credentialProviderVendor = "GoogleOauth2"|"GithubOauth2"|"SlackOauth2"|"SalesforceOauth2"|"MicrosoftOauth2"|"CustomOauth2"|"AtlassianOauth2"|"LinkedinOauth2"|"XOauth2"|"OktaOauth2"|"OneLoginOauth2"|"PingOneOauth2"|"FacebookOauth2"|"YandexOauth2"|"RedditOauth2"|"ZoomOauth2"|"TwitchOauth2"|"SpotifyOauth2"|"DropboxOauth2"|"NotionOauth2"|"HubspotOauth2"|"CyberArkOauth2"|"FusionAuthOauth2"|"Auth0Oauth2"|"CognitoOauth2",
  callbackUrl = "string",
  oauth2ProviderConfigOutput = list(
    customOauth2ProviderConfig = list(
      oauthDiscovery = list(
        discoveryUrl = "string",
        authorizationServerMetadata = list(
          issuer = "string",
          authorizationEndpoint = "string",
          tokenEndpoint = "string",
          responseTypes = list(
            "string"
          ),
          tokenEndpointAuthMethods = list(
            "string"
          )
        )
      ),
      clientId = "string",
      privateEndpoint = list(
        selfManagedLatticeResource = list(
          resourceConfigurationIdentifier = "string"
        ),
        managedVpcResource = list(
          vpcIdentifier = "string",
          subnetIds = list(
            "string"
          ),
          endpointIpAddressType = "IPV4"|"IPV6",
          securityGroupIds = list(
            "string"
          ),
          tags = list(
            "string"
          ),
          routingDomain = "string"
        )
      ),
      privateEndpointOverrides = list(
        list(
          domain = "string",
          privateEndpoint = list(
            selfManagedLatticeResource = list(
              resourceConfigurationIdentifier = "string"
            ),
            managedVpcResource = list(
              vpcIdentifier = "string",
              subnetIds = list(
                "string"
              ),
              endpointIpAddressType = "IPV4"|"IPV6",
              securityGroupIds = list(
                "string"
              ),
              tags = list(
                "string"
              ),
              routingDomain = "string"
            )
          )
        )
      ),
      onBehalfOfTokenExchangeConfig = list(
        grantType = "TOKEN_EXCHANGE"|"JWT_AUTHORIZATION_GRANT",
        tokenExchangeGrantTypeConfig = list(
          actorTokenContent = "NONE"|"M2M"|"AWS_IAM_ID_TOKEN_JWT",
          actorTokenScopes = list(
            "string"
          )
        )
      ),
      clientAuthenticationMethod = "CLIENT_SECRET_BASIC"|"CLIENT_SECRET_POST"|"AWS_IAM_ID_TOKEN_JWT"
    ),
    googleOauth2ProviderConfig = list(
      oauthDiscovery = list(
        discoveryUrl = "string",
        authorizationServerMetadata = list(
          issuer = "string",
          authorizationEndpoint = "string",
          tokenEndpoint = "string",
          responseTypes = list(
            "string"
          ),
          tokenEndpointAuthMethods = list(
            "string"
          )
        )
      ),
      clientId = "string"
    ),
    githubOauth2ProviderConfig = list(
      oauthDiscovery = list(
        discoveryUrl = "string",
        authorizationServerMetadata = list(
          issuer = "string",
          authorizationEndpoint = "string",
          tokenEndpoint = "string",
          responseTypes = list(
            "string"
          ),
          tokenEndpointAuthMethods = list(
            "string"
          )
        )
      ),
      clientId = "string"
    ),
    slackOauth2ProviderConfig = list(
      oauthDiscovery = list(
        discoveryUrl = "string",
        authorizationServerMetadata = list(
          issuer = "string",
          authorizationEndpoint = "string",
          tokenEndpoint = "string",
          responseTypes = list(
            "string"
          ),
          tokenEndpointAuthMethods = list(
            "string"
          )
        )
      ),
      clientId = "string"
    ),
    salesforceOauth2ProviderConfig = list(
      oauthDiscovery = list(
        discoveryUrl = "string",
        authorizationServerMetadata = list(
          issuer = "string",
          authorizationEndpoint = "string",
          tokenEndpoint = "string",
          responseTypes = list(
            "string"
          ),
          tokenEndpointAuthMethods = list(
            "string"
          )
        )
      ),
      clientId = "string"
    ),
    microsoftOauth2ProviderConfig = list(
      oauthDiscovery = list(
        discoveryUrl = "string",
        authorizationServerMetadata = list(
          issuer = "string",
          authorizationEndpoint = "string",
          tokenEndpoint = "string",
          responseTypes = list(
            "string"
          ),
          tokenEndpointAuthMethods = list(
            "string"
          )
        )
      ),
      clientId = "string"
    ),
    atlassianOauth2ProviderConfig = list(
      oauthDiscovery = list(
        discoveryUrl = "string",
        authorizationServerMetadata = list(
          issuer = "string",
          authorizationEndpoint = "string",
          tokenEndpoint = "string",
          responseTypes = list(
            "string"
          ),
          tokenEndpointAuthMethods = list(
            "string"
          )
        )
      ),
      clientId = "string"
    ),
    linkedinOauth2ProviderConfig = list(
      oauthDiscovery = list(
        discoveryUrl = "string",
        authorizationServerMetadata = list(
          issuer = "string",
          authorizationEndpoint = "string",
          tokenEndpoint = "string",
          responseTypes = list(
            "string"
          ),
          tokenEndpointAuthMethods = list(
            "string"
          )
        )
      ),
      clientId = "string"
    ),
    includedOauth2ProviderConfig = list(
      oauthDiscovery = list(
        discoveryUrl = "string",
        authorizationServerMetadata = list(
          issuer = "string",
          authorizationEndpoint = "string",
          tokenEndpoint = "string",
          responseTypes = list(
            "string"
          ),
          tokenEndpointAuthMethods = list(
            "string"
          )
        )
      ),
      clientId = "string"
    )
  ),
  createdTime = as.POSIXct(
    "2015-01-01"
  ),
  lastUpdatedTime = as.POSIXct(
    "2015-01-01"
  ),
  status = "CREATING"|"CREATE_FAILED"|"UPDATING"|"UPDATE_FAILED"|"READY"|"DELETING"|"DELETE_FAILED",
  failureReason = "string"
)

Request syntax

svc$get_oauth_2_credential_provider(
  name = "string"
)