Favicon

You are here: Home > API Reference > Platform > Organization Service Accounts > Add new serviceAccount

POST /organizations/:organizationId/service-accounts

Required Permission: base.people.serviceAccount.create

Add new serviceAccount

POST
https://api.applivery.io/v1/organizations/{organizationId}/service-accounts 
curl -X POST "https://api.applivery.io/v1/organizations/{organizationId}/service-accounts" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "role": "admin"
}'
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/service-accounts", {
  method: "POST",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "role": "admin"
  }),
});

const data = await response.json();
import requests

response = requests.post(
    "https://api.applivery.io/v1/organizations/{organizationId}/service-accounts",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
    json={
      "role": "admin"
    },
)

data = response.json()

Request

Send your API key in the request header authorization
Example: Authorization: Bearer <token>

organizationId string
required
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

Body Params application/json
role string required
admin editor viewer unassigned
{
    "role": "admin"
}

Responses

200 Response application/json
status boolean optional
data object optional
id string optional
Match pattern: ^[a-fA-F0-9]{24}$
organization string optional
Match pattern: ^[a-fA-F0-9]{24}$
email string optional
≤ 256 characters · Format: email
bearer string optional
≤ 128 characters
role string optional
admin editor viewer unassigned
updatedAt string optional
Format: date-time
createdAt string optional
Format: date-time
{
    "status": true,
    "data": {
        "id": "string",
        "organization": "string",
        "email": "[email protected]",
        "bearer": "string",
        "role": "admin",
        "updatedAt": "2024-01-01T00: 00:00Z",
        "createdAt": "2024-01-01T00: 00:00Z"
    }
}
400 Response application/json
status boolean optional
false
error object optional
code number optional
5017
message string optional
Limit Exceeded
{
    "status": false,
    "error": {
        "code": 5017,
        "message": "Limit Exceeded"
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4004
message string optional
Invalid Token
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}