Credentials

Manage API credentials that grant access to your Stook Buckets and subfolders.

Retrieve credentials

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organization_uuidstringRequired

The unique identifier of the organization

Responses
200

Credentials retrieved successfully

application/json
get
/api/v2/stook/{organization_uuid}/credential
200

Credentials retrieved successfully

Retrieve credential details

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organization_uuidstringRequired

The UUID of the organization

credential_uuidstringRequired

The UUID of the credential

Responses
200

Credential details retrieved successfully

application/json
get
/api/v2/stook/{organization_uuid}/credential/{credential_uuid}
200

Credential details retrieved successfully

Create a new credential

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organization_uuidstringRequired

The unique identifier of the organization

Body
namestringRequired

The name of the credential

is_readonlybooleanOptional

Indicates if the credential is read-only

bucketsstring[]Required

UUID of the bucket

subfolderstringOptional

The subfolder within the bucket

Responses
200

Credential successfully created

application/json
post
/api/v2/stook/{organization_uuid}/credentials
200

Credential successfully created

Update an existing credential

put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organization_uuidstringRequired

The unique identifier of the organization

credential_uuidstringRequired

The unique identifier of the credential

Body
namestringRequired

The name of the credential

is_readonlybooleanRequired

Indicates if the credential is read-only

bucketsstring[]Required

UUID of the bucket

subfolderstringOptional

The subfolder within the bucket

Responses
200

Credential successfully updated

application/json
put
/api/v2/stook/{organization_uuid}/credential/{credential_uuid}
200

Credential successfully updated

Delete a credential

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organization_uuidstringRequired

The UUID of the organization

credential_uuidstringRequired

The UUID of the credential

Responses
200

Credential successfully deleted

application/json
delete
/api/v2/stook/{organization_uuid}/credential/{credential_uuid}
200

Credential successfully deleted

Last updated

Was this helpful?