Skip to main content
PUT
Update a service account with new roles and permissions

Authorizations

Authorization
string
header
required

The primary authentication method for the Mezmo API.

Pass the key in the Authorization header in the format Token <ACCESS TOKEN>. For example:

This key is used for all APIs with the exception of ingest.

Path Parameters

service_account_id
string
required

The unique identifier of the service account to updated

Maximum string length: 24
Pattern: ^[a-f\d]{24}$

Body

application/json

A service account is a special type of account intended to represent a non-human user that needs to authenticate and be authorized to access data in APIs.

A service account is a special type of account intended to represent a non-human user that needs to authenticate and be authorized to access data in APIs.

name
string
required

A user friendly, name for a service account.

Required string length: 3 - 128
Pattern: ^[a-zA-Z0-9_\-.\[\]() ]+$
Example:

"Terraform Provider Pipeline Provisioning"

description
string | null

Additional information to provide further context around the use cases for the service account.

Maximum string length: 250
Example:

"Used for provisioning pipelines via terraform"

roles
string[]

A list of role identifiers to grant to the service account

Maximum array length: 25
Maximum string length: 24
Example:
permissions
Permission list to be specified in requests body · object

Permissions represent the set of resources a particular entity has access to.

Example:

Response

Response format containing the updated service account, in addition to the standard metadata object.

Response format containing the updated service account, in addition to the standard metadata object.

meta
object
required

Contains additional contextual information about the api response.

data
Service Account · object
required

A service account is a special type of account intended to represent a non-human user that needs to authenticate and be authorized to access data in APIs.