Skip to content
sgp
API Reference

Credentials

Create Credential
credentials.create(CredentialCreateParams**kwargs) -> Credential
POST/v5/credentials
Get Credential by ID
credentials.retrieve(strcredential_id) -> Credential
GET/v5/credentials/{credential_id}
Get Credential by Name
credentials.retrieve_by_name(strcredential_name) -> Credential
GET/v5/credentials/name/{credential_name}
Get Credential Secret by ID
credentials.decrypt(strcredential_id) -> CredentialSecret
POST/v5/credentials/{credential_id}/secret
Get Credential Secret by Name
credentials.decrypt_by_name(strcredential_name) -> CredentialSecret
POST/v5/credentials/name/{credential_name}/secret
List Credentials
credentials.list(CredentialListParams**kwargs) -> SyncCursorPage[Credential]
GET/v5/credentials
Update Credential
credentials.update(strcredential_id, CredentialUpdateParams**kwargs) -> Credential
PATCH/v5/credentials/{credential_id}
Delete Credential
credentials.delete(strcredential_id) -> CredentialDeleteResponse
DELETE/v5/credentials/{credential_id}
ModelsExpand Collapse
class Credential: …
id: str
created_at: datetime
formatdate-time
created_by_identity_type: Optional[str]
created_by_user_id: Optional[str]
credential_metadata: Optional[Dict[str, object]]
description: Optional[str]
name: str
type: str
updated_at: datetime
formatdate-time
object: Optional[str]
class CredentialSecret: …
result: str
object: Optional[str]
class CredentialDeleteResponse: …
id: str
deleted: bool
object: Optional[str]