Skip to main content
POST
/
api
/
disks
/
{id}
/
users
Add user to disk
curl --request POST \
  --url https://control.green.us-east-1.aws.prod.archil.com/api/disks/{id}/users \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "token",
  "nickname": "<string>",
  "principal": "<string>",
  "tokenSuffix": "<string>"
}
'
{
  "success": true,
  "data": {
    "type": "token",
    "principal": "<string>",
    "nickname": "<string>",
    "tokenSuffix": "<string>",
    "token": "<string>",
    "identifier": "<string>",
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

API key (format key-{API_KEY})

Path Parameters

​
id
string
required

Disk ID (format dsk-{16 hex chars})

Pattern: ^dsk-[0-9a-f]{16}$
Example:

"dsk-0123456789abcdef"

Body

application/json
​
type
enum<string>
required
Available options:
token
​
nickname
string
required
Maximum string length: 255
​
principal
string
deprecated

Deprecated. Client-provided token. If omitted, the server generates a cryptographically secure token and returns it in the response.

Maximum string length: 2048
​
tokenSuffix
string
deprecated

Deprecated. Last 4 characters of the token. Required when principal is provided; ignored when the server generates the token.

Required string length: 4

Response

User added successfully

​
success
boolean
required
Example:

true

​
data
object
required