BedrockAgentCoreControl / Client / get_oauth2_credential_provider

get_oauth2_credential_provider¶

BedrockAgentCoreControl.Client.get_oauth2_credential_provider(**kwargs)¶

Retrieves information about an OAuth2 credential provider.

Request Syntax

response = client.get_oauth2_credential_provider(
    name='string'
)

Parameters:

name (string) –

[REQUIRED]

The name of the OAuth2 credential provider to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'clientSecretArn': {
        'secretArn': 'string'
    },
    'clientSecretJsonKey': 'string',
    'clientSecretSource': 'MANAGED'|'EXTERNAL',
    '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': {
        'customOauth2ProviderConfig': {
            'oauthDiscovery': {
                'discoveryUrl': 'string',
                'authorizationServerMetadata': {
                    'issuer': 'string',
                    'authorizationEndpoint': 'string',
                    'tokenEndpoint': 'string',
                    'responseTypes': [
                        'string',
                    ],
                    'tokenEndpointAuthMethods': [
                        'string',
                    ]
                }
            },
            'clientId': 'string',
            'privateEndpoint': {
                'selfManagedLatticeResource': {
                    'resourceConfigurationIdentifier': 'string'
                },
                'managedVpcResource': {
                    'vpcIdentifier': 'string',
                    'subnetIds': [
                        'string',
                    ],
                    'endpointIpAddressType': 'IPV4'|'IPV6',
                    'securityGroupIds': [
                        'string',
                    ],
                    'tags': {
                        'string': 'string'
                    },
                    'routingDomain': 'string'
                }
            },
            'privateEndpointOverrides': [
                {
                    'domain': 'string',
                    'privateEndpoint': {
                        'selfManagedLatticeResource': {
                            'resourceConfigurationIdentifier': 'string'
                        },
                        'managedVpcResource': {
                            'vpcIdentifier': 'string',
                            'subnetIds': [
                                'string',
                            ],
                            'endpointIpAddressType': 'IPV4'|'IPV6',
                            'securityGroupIds': [
                                'string',
                            ],
                            'tags': {
                                'string': 'string'
                            },
                            'routingDomain': 'string'
                        }
                    }
                },
            ],
            'onBehalfOfTokenExchangeConfig': {
                'grantType': 'TOKEN_EXCHANGE'|'JWT_AUTHORIZATION_GRANT',
                'tokenExchangeGrantTypeConfig': {
                    'actorTokenContent': 'NONE'|'M2M'|'AWS_IAM_ID_TOKEN_JWT',
                    'actorTokenScopes': [
                        'string',
                    ]
                }
            },
            'clientAuthenticationMethod': 'CLIENT_SECRET_BASIC'|'CLIENT_SECRET_POST'|'AWS_IAM_ID_TOKEN_JWT'
        },
        'googleOauth2ProviderConfig': {
            'oauthDiscovery': {
                'discoveryUrl': 'string',
                'authorizationServerMetadata': {
                    'issuer': 'string',
                    'authorizationEndpoint': 'string',
                    'tokenEndpoint': 'string',
                    'responseTypes': [
                        'string',
                    ],
                    'tokenEndpointAuthMethods': [
                        'string',
                    ]
                }
            },
            'clientId': 'string'
        },
        'githubOauth2ProviderConfig': {
            'oauthDiscovery': {
                'discoveryUrl': 'string',
                'authorizationServerMetadata': {
                    'issuer': 'string',
                    'authorizationEndpoint': 'string',
                    'tokenEndpoint': 'string',
                    'responseTypes': [
                        'string',
                    ],
                    'tokenEndpointAuthMethods': [
                        'string',
                    ]
                }
            },
            'clientId': 'string'
        },
        'slackOauth2ProviderConfig': {
            'oauthDiscovery': {
                'discoveryUrl': 'string',
                'authorizationServerMetadata': {
                    'issuer': 'string',
                    'authorizationEndpoint': 'string',
                    'tokenEndpoint': 'string',
                    'responseTypes': [
                        'string',
                    ],
                    'tokenEndpointAuthMethods': [
                        'string',
                    ]
                }
            },
            'clientId': 'string'
        },
        'salesforceOauth2ProviderConfig': {
            'oauthDiscovery': {
                'discoveryUrl': 'string',
                'authorizationServerMetadata': {
                    'issuer': 'string',
                    'authorizationEndpoint': 'string',
                    'tokenEndpoint': 'string',
                    'responseTypes': [
                        'string',
                    ],
                    'tokenEndpointAuthMethods': [
                        'string',
                    ]
                }
            },
            'clientId': 'string'
        },
        'microsoftOauth2ProviderConfig': {
            'oauthDiscovery': {
                'discoveryUrl': 'string',
                'authorizationServerMetadata': {
                    'issuer': 'string',
                    'authorizationEndpoint': 'string',
                    'tokenEndpoint': 'string',
                    'responseTypes': [
                        'string',
                    ],
                    'tokenEndpointAuthMethods': [
                        'string',
                    ]
                }
            },
            'clientId': 'string'
        },
        'atlassianOauth2ProviderConfig': {
            'oauthDiscovery': {
                'discoveryUrl': 'string',
                'authorizationServerMetadata': {
                    'issuer': 'string',
                    'authorizationEndpoint': 'string',
                    'tokenEndpoint': 'string',
                    'responseTypes': [
                        'string',
                    ],
                    'tokenEndpointAuthMethods': [
                        'string',
                    ]
                }
            },
            'clientId': 'string'
        },
        'linkedinOauth2ProviderConfig': {
            'oauthDiscovery': {
                'discoveryUrl': 'string',
                'authorizationServerMetadata': {
                    'issuer': 'string',
                    'authorizationEndpoint': 'string',
                    'tokenEndpoint': 'string',
                    'responseTypes': [
                        'string',
                    ],
                    'tokenEndpointAuthMethods': [
                        'string',
                    ]
                }
            },
            'clientId': 'string'
        },
        'includedOauth2ProviderConfig': {
            'oauthDiscovery': {
                'discoveryUrl': 'string',
                'authorizationServerMetadata': {
                    'issuer': 'string',
                    'authorizationEndpoint': 'string',
                    'tokenEndpoint': 'string',
                    'responseTypes': [
                        'string',
                    ],
                    'tokenEndpointAuthMethods': [
                        'string',
                    ]
                }
            },
            'clientId': 'string'
        }
    },
    'createdTime': datetime(2015, 1, 1),
    'lastUpdatedTime': datetime(2015, 1, 1),
    'status': 'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'READY'|'DELETING'|'DELETE_FAILED',
    'failureReason': 'string'
}

Response Structure

(dict) –
- clientSecretArn (dict) –
  
  The Amazon Resource Name (ARN) of the client secret in AWS Secrets Manager.
  - secretArn (string) –
    
    The Amazon Resource Name (ARN) of the secret in AWS Secrets Manager.
- clientSecretJsonKey (string) –
  
  The JSON key used to extract the client secret value from the AWS Secrets Manager secret.
- clientSecretSource (string) –
  
  The source type of the client secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in AWS Secrets Manager.
- name (string) –
  
  The name of the OAuth2 credential provider.
- credentialProviderArn (string) –
  
  ARN of the credential provider requested.
- credentialProviderVendor (string) –
  
  The vendor of the OAuth2 credential provider.
- callbackUrl (string) –
  
  Callback URL to register on the OAuth2 credential provider as an allowed callback URL. This URL is where the OAuth2 authorization server redirects users after they complete the authorization flow.
- oauth2ProviderConfigOutput (dict) –
  
  The configuration output for the OAuth2 provider.
  Note
  This is a Tagged Union structure. Only one of the following top level keys will be set: customOauth2ProviderConfig, googleOauth2ProviderConfig, githubOauth2ProviderConfig, slackOauth2ProviderConfig, salesforceOauth2ProviderConfig, microsoftOauth2ProviderConfig, atlassianOauth2ProviderConfig, linkedinOauth2ProviderConfig, includedOauth2ProviderConfig. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
  'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
  - customOauth2ProviderConfig (dict) –
    
    The output configuration for a custom OAuth2 provider.
    - oauthDiscovery (dict) –
      
      The OAuth2 discovery information for the custom provider.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: discoveryUrl, authorizationServerMetadata. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - discoveryUrl (string) –
        
        The discovery URL for the OAuth2 provider.
      - authorizationServerMetadata (dict) –
        
        The authorization server metadata for the OAuth2 provider.
        
        issuer (string) –
        
        The issuer URL for the OAuth2 authorization server.
        
        authorizationEndpoint (string) –
        
        The authorization endpoint URL for the OAuth2 authorization server.
        
        tokenEndpoint (string) –
        
        The token endpoint URL for the OAuth2 authorization server.
        
        responseTypes (list) –
        
        The supported response types for the OAuth2 authorization server.
        
        (string) –
        
        tokenEndpointAuthMethods (list) –
        
        The authentication methods supported by the token endpoint. This specifies how clients can authenticate when requesting tokens from the authorization server.
        
        (string) –
    - clientId (string) –
      
      The client ID for the custom OAuth2 provider.
    - privateEndpoint (dict) –
      
      The default private endpoint for the custom OAuth2 provider, enabling secure connectivity through a VPC Lattice resource configuration.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: selfManagedLatticeResource, managedVpcResource. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - selfManagedLatticeResource (dict) –
        
        Configuration for connecting to a private resource using a self-managed VPC Lattice resource configuration.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: resourceConfigurationIdentifier. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        resourceConfigurationIdentifier (string) –
        
        The ARN or ID of the VPC Lattice resource configuration.
      - managedVpcResource (dict) –
        
        Configuration for connecting to a private resource using a managed VPC Lattice resource. The gateway creates and manages the VPC Lattice resources on your behalf.
        
        vpcIdentifier (string) –
        
        The ID of the VPC that contains your private resource.
        
        subnetIds (list) –
        
        The subnet IDs within the VPC where the VPC Lattice resource gateway is placed.
        
        (string) –
        
        endpointIpAddressType (string) –
        
        The IP address type for the resource configuration endpoint.
        
        securityGroupIds (list) –
        
        The security group IDs to associate with the VPC Lattice resource gateway. If not specified, the default security group for the VPC is used.
        
        (string) –
        
        tags (dict) –
        
        Tags to apply to the managed VPC Lattice resource gateway.
        
        (string) –
        
        (string) –
        
        routingDomain (string) –
        
        An intermediate domain to use as the resource configuration endpoint instead of the actual target domain. Use this when you want to route traffic through an intermediate component such as a VPC endpoint or internal load balancer. For more information, see xref:lattice-vpc-egress-routing-domain[Route traffic through an intermediate domain].
    - privateEndpointOverrides (list) –
      
      The private endpoint overrides for the custom OAuth2 provider configuration.
      - (dict) –
        
        A mapping of a specific domain to a private endpoint for secure connectivity through a VPC Lattice resource configuration.
        
        domain (string) –
        
        The domain to override with a private endpoint.
        
        privateEndpoint (dict) –
        
        The private endpoint configuration for the specified domain.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: selfManagedLatticeResource, managedVpcResource. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        selfManagedLatticeResource (dict) –
        
        Configuration for connecting to a private resource using a self-managed VPC Lattice resource configuration.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: resourceConfigurationIdentifier. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        resourceConfigurationIdentifier (string) –
        
        The ARN or ID of the VPC Lattice resource configuration.
        
        managedVpcResource (dict) –
        
        Configuration for connecting to a private resource using a managed VPC Lattice resource. The gateway creates and manages the VPC Lattice resources on your behalf.
        
        vpcIdentifier (string) –
        
        The ID of the VPC that contains your private resource.
        
        subnetIds (list) –
        
        The subnet IDs within the VPC where the VPC Lattice resource gateway is placed.
        
        (string) –
        
        endpointIpAddressType (string) –
        
        The IP address type for the resource configuration endpoint.
        
        securityGroupIds (list) –
        
        The security group IDs to associate with the VPC Lattice resource gateway. If not specified, the default security group for the VPC is used.
        
        (string) –
        
        tags (dict) –
        
        Tags to apply to the managed VPC Lattice resource gateway.
        
        (string) –
        
        (string) –
        
        routingDomain (string) –
        
        An intermediate domain to use as the resource configuration endpoint instead of the actual target domain. Use this when you want to route traffic through an intermediate component such as a VPC endpoint or internal load balancer. For more information, see xref:lattice-vpc-egress-routing-domain[Route traffic through an intermediate domain].
    - onBehalfOfTokenExchangeConfig (dict) –
      
      The configuration for on-behalf-of token exchange.
      - grantType (string) –
        
        The grant type for the on-behalf-of token exchange.
      - tokenExchangeGrantTypeConfig (dict) –
        
        Configuration specific to the TOKEN_EXCHANGE grant type (RFC 8693).
        
        actorTokenContent (string) –
        
        The content type for the actor token in the token exchange.
        
        actorTokenScopes (list) –
        
        The scopes for the actor token. Only valid when actorTokenContent is M2M.
        
        (string) –
    - clientAuthenticationMethod (string) –
      
      The client authentication method used when authenticating with the token endpoint.
  - googleOauth2ProviderConfig (dict) –
    
    The output configuration for a Google OAuth2 provider.
    - oauthDiscovery (dict) –
      
      The OAuth2 discovery information for the Google provider.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: discoveryUrl, authorizationServerMetadata. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - discoveryUrl (string) –
        
        The discovery URL for the OAuth2 provider.
      - authorizationServerMetadata (dict) –
        
        The authorization server metadata for the OAuth2 provider.
        
        issuer (string) –
        
        The issuer URL for the OAuth2 authorization server.
        
        authorizationEndpoint (string) –
        
        The authorization endpoint URL for the OAuth2 authorization server.
        
        tokenEndpoint (string) –
        
        The token endpoint URL for the OAuth2 authorization server.
        
        responseTypes (list) –
        
        The supported response types for the OAuth2 authorization server.
        
        (string) –
        
        tokenEndpointAuthMethods (list) –
        
        The authentication methods supported by the token endpoint. This specifies how clients can authenticate when requesting tokens from the authorization server.
        
        (string) –
    - clientId (string) –
      
      The client ID for the Google OAuth2 provider.
  - githubOauth2ProviderConfig (dict) –
    
    The output configuration for a GitHub OAuth2 provider.
    - oauthDiscovery (dict) –
      
      The OAuth2 discovery information for the GitHub provider.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: discoveryUrl, authorizationServerMetadata. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - discoveryUrl (string) –
        
        The discovery URL for the OAuth2 provider.
      - authorizationServerMetadata (dict) –
        
        The authorization server metadata for the OAuth2 provider.
        
        issuer (string) –
        
        The issuer URL for the OAuth2 authorization server.
        
        authorizationEndpoint (string) –
        
        The authorization endpoint URL for the OAuth2 authorization server.
        
        tokenEndpoint (string) –
        
        The token endpoint URL for the OAuth2 authorization server.
        
        responseTypes (list) –
        
        The supported response types for the OAuth2 authorization server.
        
        (string) –
        
        tokenEndpointAuthMethods (list) –
        
        The authentication methods supported by the token endpoint. This specifies how clients can authenticate when requesting tokens from the authorization server.
        
        (string) –
    - clientId (string) –
      
      The client ID for the GitHub OAuth2 provider.
  - slackOauth2ProviderConfig (dict) –
    
    The output configuration for a Slack OAuth2 provider.
    - oauthDiscovery (dict) –
      
      The OAuth2 discovery information for the Slack provider.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: discoveryUrl, authorizationServerMetadata. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - discoveryUrl (string) –
        
        The discovery URL for the OAuth2 provider.
      - authorizationServerMetadata (dict) –
        
        The authorization server metadata for the OAuth2 provider.
        
        issuer (string) –
        
        The issuer URL for the OAuth2 authorization server.
        
        authorizationEndpoint (string) –
        
        The authorization endpoint URL for the OAuth2 authorization server.
        
        tokenEndpoint (string) –
        
        The token endpoint URL for the OAuth2 authorization server.
        
        responseTypes (list) –
        
        The supported response types for the OAuth2 authorization server.
        
        (string) –
        
        tokenEndpointAuthMethods (list) –
        
        The authentication methods supported by the token endpoint. This specifies how clients can authenticate when requesting tokens from the authorization server.
        
        (string) –
    - clientId (string) –
      
      The client ID for the Slack OAuth2 provider.
  - salesforceOauth2ProviderConfig (dict) –
    
    The output configuration for a Salesforce OAuth2 provider.
    - oauthDiscovery (dict) –
      
      The OAuth2 discovery information for the Salesforce provider.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: discoveryUrl, authorizationServerMetadata. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - discoveryUrl (string) –
        
        The discovery URL for the OAuth2 provider.
      - authorizationServerMetadata (dict) –
        
        The authorization server metadata for the OAuth2 provider.
        
        issuer (string) –
        
        The issuer URL for the OAuth2 authorization server.
        
        authorizationEndpoint (string) –
        
        The authorization endpoint URL for the OAuth2 authorization server.
        
        tokenEndpoint (string) –
        
        The token endpoint URL for the OAuth2 authorization server.
        
        responseTypes (list) –
        
        The supported response types for the OAuth2 authorization server.
        
        (string) –
        
        tokenEndpointAuthMethods (list) –
        
        The authentication methods supported by the token endpoint. This specifies how clients can authenticate when requesting tokens from the authorization server.
        
        (string) –
    - clientId (string) –
      
      The client ID for the Salesforce OAuth2 provider.
  - microsoftOauth2ProviderConfig (dict) –
    
    The output configuration for a Microsoft OAuth2 provider.
    - oauthDiscovery (dict) –
      
      The OAuth2 discovery information for the Microsoft provider.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: discoveryUrl, authorizationServerMetadata. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - discoveryUrl (string) –
        
        The discovery URL for the OAuth2 provider.
      - authorizationServerMetadata (dict) –
        
        The authorization server metadata for the OAuth2 provider.
        
        issuer (string) –
        
        The issuer URL for the OAuth2 authorization server.
        
        authorizationEndpoint (string) –
        
        The authorization endpoint URL for the OAuth2 authorization server.
        
        tokenEndpoint (string) –
        
        The token endpoint URL for the OAuth2 authorization server.
        
        responseTypes (list) –
        
        The supported response types for the OAuth2 authorization server.
        
        (string) –
        
        tokenEndpointAuthMethods (list) –
        
        The authentication methods supported by the token endpoint. This specifies how clients can authenticate when requesting tokens from the authorization server.
        
        (string) –
    - clientId (string) –
      
      The client ID for the Microsoft OAuth2 provider.
  - atlassianOauth2ProviderConfig (dict) –
    
    The configuration details for the Atlassian OAuth2 provider.
    - oauthDiscovery (dict) –
      
      Contains the discovery information for an OAuth2 provider.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: discoveryUrl, authorizationServerMetadata. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - discoveryUrl (string) –
        
        The discovery URL for the OAuth2 provider.
      - authorizationServerMetadata (dict) –
        
        The authorization server metadata for the OAuth2 provider.
        
        issuer (string) –
        
        The issuer URL for the OAuth2 authorization server.
        
        authorizationEndpoint (string) –
        
        The authorization endpoint URL for the OAuth2 authorization server.
        
        tokenEndpoint (string) –
        
        The token endpoint URL for the OAuth2 authorization server.
        
        responseTypes (list) –
        
        The supported response types for the OAuth2 authorization server.
        
        (string) –
        
        tokenEndpointAuthMethods (list) –
        
        The authentication methods supported by the token endpoint. This specifies how clients can authenticate when requesting tokens from the authorization server.
        
        (string) –
    - clientId (string) –
      
      The client ID for the Atlassian OAuth2 provider.
  - linkedinOauth2ProviderConfig (dict) –
    
    The configuration details for the LinkedIn OAuth2 provider.
    - oauthDiscovery (dict) –
      
      Contains the discovery information for an OAuth2 provider.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: discoveryUrl, authorizationServerMetadata. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - discoveryUrl (string) –
        
        The discovery URL for the OAuth2 provider.
      - authorizationServerMetadata (dict) –
        
        The authorization server metadata for the OAuth2 provider.
        
        issuer (string) –
        
        The issuer URL for the OAuth2 authorization server.
        
        authorizationEndpoint (string) –
        
        The authorization endpoint URL for the OAuth2 authorization server.
        
        tokenEndpoint (string) –
        
        The token endpoint URL for the OAuth2 authorization server.
        
        responseTypes (list) –
        
        The supported response types for the OAuth2 authorization server.
        
        (string) –
        
        tokenEndpointAuthMethods (list) –
        
        The authentication methods supported by the token endpoint. This specifies how clients can authenticate when requesting tokens from the authorization server.
        
        (string) –
    - clientId (string) –
      
      The client ID for the LinkedIn OAuth2 provider.
  - includedOauth2ProviderConfig (dict) –
    
    The configuration for a non-custom OAuth2 provider. This includes the configuration details for supported OAuth2 providers that have built-in integration support.
    - oauthDiscovery (dict) –
      
      Contains the discovery information for an OAuth2 provider.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: discoveryUrl, authorizationServerMetadata. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - discoveryUrl (string) –
        
        The discovery URL for the OAuth2 provider.
      - authorizationServerMetadata (dict) –
        
        The authorization server metadata for the OAuth2 provider.
        
        issuer (string) –
        
        The issuer URL for the OAuth2 authorization server.
        
        authorizationEndpoint (string) –
        
        The authorization endpoint URL for the OAuth2 authorization server.
        
        tokenEndpoint (string) –
        
        The token endpoint URL for the OAuth2 authorization server.
        
        responseTypes (list) –
        
        The supported response types for the OAuth2 authorization server.
        
        (string) –
        
        tokenEndpointAuthMethods (list) –
        
        The authentication methods supported by the token endpoint. This specifies how clients can authenticate when requesting tokens from the authorization server.
        
        (string) –
    - clientId (string) –
      
      The client ID for the supported OAuth2 provider.
- createdTime (datetime) –
  
  The timestamp when the OAuth2 credential provider was created.
- lastUpdatedTime (datetime) –
  
  The timestamp when the OAuth2 credential provider was last updated.
- status (string) –
  
  The current status of the OAuth2 credential provider.
- failureReason (string) –
  
  The reason for failure if the OAuth2 credential provider is in a failed state.

Exceptions

BedrockAgentCoreControl.Client.exceptions.UnauthorizedException
BedrockAgentCoreControl.Client.exceptions.ValidationException
BedrockAgentCoreControl.Client.exceptions.AccessDeniedException
BedrockAgentCoreControl.Client.exceptions.DecryptionFailure
BedrockAgentCoreControl.Client.exceptions.ResourceNotFoundException
BedrockAgentCoreControl.Client.exceptions.ThrottlingException
BedrockAgentCoreControl.Client.exceptions.InternalServerException