Skip to content

Credentials

Create Credential
client.Credentials.New(ctx, body) (*Credential, error)
POST/v5/credentials
Get Credential by ID
client.Credentials.Get(ctx, credentialID) (*Credential, error)
GET/v5/credentials/{credential_id}
Get Credential by Name
client.Credentials.GetByName(ctx, credentialName) (*Credential, error)
GET/v5/credentials/name/{credential_name}
Get Credential Secret by ID
client.Credentials.Decrypt(ctx, credentialID) (*CredentialSecret, error)
POST/v5/credentials/{credential_id}/secret
Get Credential Secret by Name
client.Credentials.DecryptByName(ctx, credentialName) (*CredentialSecret, error)
POST/v5/credentials/name/{credential_name}/secret
List Credentials
client.Credentials.List(ctx, query) (*CursorPage[Credential], error)
GET/v5/credentials
Update Credential
client.Credentials.Update(ctx, credentialID, body) (*Credential, error)
PATCH/v5/credentials/{credential_id}
Delete Credential
client.Credentials.Delete(ctx, credentialID) (*CredentialDeleteResponse, error)
DELETE/v5/credentials/{credential_id}
ModelsExpand Collapse
type Credential struct{…}
ID string
CreatedAt Time
formatdate-time
CreatedByIdentityType string
CreatedByUserID string
CredentialMetadata map[string, any]
Description string
Name string
Type string
UpdatedAt Time
formatdate-time
Object stringOptional
type CredentialSecret struct{…}
Result string
Object stringOptional