Skip to content

ServiceAccountOperations

Access via client.service_accounts. Service accounts are non-human users for instruments and automated pipelines. get_admin(), list_admin(), and set_platform_role() are for platform administrators and elevate on their own.

account = client.service_accounts.create("xrd-uploader")
rotated = client.service_accounts.rotate_key(account["unique_id"])

crucible.resources.service_accounts.ServiceAccountOperations

Operations for service accounts.

Access via: client.service_accounts.*

create(username, unique_id=None)

Create a new service account.

The API key is returned once only — store it immediately.

Parameters:

Name Type Description Default
username str

Unique 3-to-24-character username.

required
unique_id Optional[str]

Optional MFID. Server generates one if omitted.

None

Returns:

Type Description
Dict

Dict with unique_id, username, is_service_account, and api_key.

Raises:

Type Description
HTTPError 409

username or unique_id already exists.

rotate_key(service_account_ref)

Generate a new API key for a service account, revoking every key it holds.

The new key is returned once only — store it immediately.

Parameters:

Name Type Description Default
service_account_ref str

Service account MFID.

required

Returns:

Type Description
Dict

Dict with service_account_ref, username, is_service_account, and api_key.

Raises:

Type Description
HTTPError 404

service_account_ref does not correspond to a service account.

get(service_account_mfid=None, username=None, *, unique_id=None)

Get a service account by MFID or username.

Parameters:

Name Type Description Default
service_account_mfid Optional[str]

Service account MFID.

None
username Optional[str]

Service account username.

None
unique_id Optional[str]

Removed in 4.0.0; passing it raises RemovedError. Use service_account_mfid.

None

Returns:

Name Type Description
Dict Optional[Dict]

User record, or None if not found.

list(limit=DEFAULT_LIMIT)

List all service accounts.

Parameters:

Name Type Description Default
limit int

Maximum number of results.

DEFAULT_LIMIT

Returns:

Type Description
List[Dict]

List of user records with is_service_account=True.

update(service_account_ref, **kwargs)

Update a service account record.

Parameters:

Name Type Description Default
service_account_ref str

Service account MFID.

required
**kwargs Any

Fields to update. Accepted: username, first_name, last_name.

{}

Returns:

Name Type Description
Dict Dict

Updated user record.

list_access_groups(service_account_ref)

List access group names a service account belongs to.

Parameters:

Name Type Description Default
service_account_ref str

Service account MFID.

required

Returns:

Type Description
List[str]

List[str]: Access group names.

get_admin(service_account_mfid)

Get a service account's administrative record. Admin only.

Unlike get(), this returns the platform role and API key status, which the shared user endpoints do not expose.

Parameters:

Name Type Description Default
service_account_mfid str

Service account MFID.

required

Returns:

Name Type Description
Dict Dict

unique_id, username, first_name, last_name, email, platform_role, and api_key_status (created_at, expires_at, valid).

list_admin(q=None, limit=DEFAULT_LIMIT, offset=0, cursor=None)

List service accounts with their administrative records. Admin only.

Parameters:

Name Type Description Default
q Optional[str]

Optional search string, at least 3 characters.

None
limit int

Maximum number of results.

DEFAULT_LIMIT
offset int

Starting position in the full result set.

0
cursor str

Continuation token from a previous result's next_cursor; the listing resumes there.

None

Returns:

Type Description
List[Dict]

List of service account records including platform_role.

set_platform_role(service_account_mfid, platform_role)

Set a service account's platform-wide role. Admin only.

Parameters:

Name Type Description Default
service_account_mfid str

Service account MFID.

required
platform_role str

One of crucible.constants.PLATFORM_ROLES.

required

Returns:

Name Type Description
Dict Dict

The updated administrative record.