mage.api_resources.assessment_run_credential_connection module

class mage.api_resources.assessment_run_credential_connection.AssessmentRunCredentialConnection

Bases: mage.api_resources.abstract.mutable_api_resource.MutableAPIResource

Connection between an assessment run and a credential.

id

Unique connection ID

Type

str

created_at

When the connection was created (e.g., ‘2020-01-02T03:04:56.789Z’)

Type

str

updated_at

When the connection was last updated (e.g., ‘2020-01-02T03:04:56.789Z’)

Type

str

asset_id

ID of the associated asset

Type

str

credential_id

ID of the associated credential

Type

str

Type

mage.schema.CredentialLinkType

property assessment

Warning

Not Implemented. Use assessment_run instead.

property assessment_id

Warning

Not Implemented. Use assessment_run_id instead.

property assessment_run

The associated assessment run.

Returns

AssessmentRun

property assessment_run_id

ID of the associated assessment run.

Returns

str

property asset

The associated asset.

Returns

Asset

classmethod create(assessment_run_id, credential_id)

Connects a credential to an assessment run.

Parameters
  • assessment_run_id (str) – ID of the assessment run

  • credential_id (str) – ID of the credential

Returns

AssessmentRunAssetConnection

Example

>>> import mage
>>> mage.connect()
>>> mage.AssessmentRunAssetConnection.create('11111111-1111-1111-1111-111111111111', '22222222-2222-2222-2222-222222222222')
property credential

The associated credential.

Returns

Credential