SecurityAgent / Client / get_integration

get_integration¶

SecurityAgent.Client.get_integration(**kwargs)¶

Gets Integration metadata from the provided id

Request Syntax

response = client.get_integration(
    integrationId='string'
)

Parameters:

integrationId (string) –

[REQUIRED]

Unique identifier of the integration

Return type:

dict

Returns:

Response Syntax

{
    'integrationId': 'string',
    'installationId': 'string',
    'provider': 'GITHUB',
    'providerType': 'SOURCE_CODE'|'DOCUMENTATION',
    'displayName': 'string',
    'kmsKeyId': 'string'
}

Response Structure

(dict) –
- integrationId (string) –
  
  Unique identifier of the integration
- installationId (string) –
  
  Installation identifier from the provider
- provider (string) –
  
  Provider type
- providerType (string) –
  
  Type of provider integration
- displayName (string) –
  
  Display name for the integration
- kmsKeyId (string) –
  
  KMS key ID for encrypting integration details

Exceptions

SecurityAgent.Client.exceptions.ResourceNotFoundException
SecurityAgent.Client.exceptions.ValidationException
SecurityAgent.Client.exceptions.InternalServerException
SecurityAgent.Client.exceptions.ThrottlingException
SecurityAgent.Client.exceptions.AccessDeniedException