Skip to content
OpenBot

userTokens.createToken

POST
/v1/user/tokens
curl --request POST \
  --url https://example.com/v1/user/tokens \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "expiresInDays": 1, "policies": [ { "effect": "allow", "permissionGroups": [ "responses.run" ], "resources": [ "example" ] } ] }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
expiresInDays
integer
>= 1 <= 365
policies
Array<object>
>= 1 items <= 50 items
object
effect
required
string
Allowed values: allow deny
permissionGroups
required
Array<string>
>= 1 items
Allowed values: responses.run sessions.read sessions.write requests.resolve agents.read agents.write agents.delegate connections.read connections.write apps.use apps.publish models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read
resources
required
Array<string>
>= 1 items

Responses

Section titled “Responses”

201

Section titled “201”

Success

Media typeapplication/json
object
token
required
object
id
required
string
name
required
string
prefix
required
string
policies
required
Array<object>
<= 50 items
object
effect
required
string
Allowed values: allow deny
permissionGroups
required
Array<string>
>= 1 items
Allowed values: responses.run sessions.read sessions.write requests.resolve agents.read agents.write agents.delegate connections.read connections.write apps.use apps.publish models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read
resources
required
Array<string>
>= 1 items
createdAt
required
string
expiresAt
required
Any of:
string
lastUsedAt
required
Any of:
string
secret
required
string

Example 

{
  "token": {
    "policies": [
      {
        "effect": "allow",
        "permissionGroups": [
          "responses.run"
        ]
      }
    ]
  }
}

400

Section titled “400”

TokenPolicyInvalid | OrganizationRequired

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: TokenPolicyInvalid
message
required
string

Example 

{
  "_tag": "TokenPolicyInvalid"
}

401

Section titled “401”

AuthenticationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: AuthenticationRequired

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: PermissionDenied
permission
required
string
Allowed values: responses.run sessions.read sessions.write requests.resolve agents.read agents.write agents.delegate connections.read connections.write apps.use apps.publish models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read
resource
required
string

Example 

{
  "_tag": "PermissionDenied",
  "permission": "responses.run"
}

409

Section titled “409”

TokenLimitReached

Media typeapplication/json
object
_tag
required
string
Allowed values: TokenLimitReached
limit
required
integer
>= -9007199254740991 <= 9007199254740991

Example 

{
  "_tag": "TokenLimitReached"
}

503

Section titled “503”

TokenStorageUnavailable | AuthorizationUnavailable | AuthenticationUnavailable

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: TokenStorageUnavailable

Example 

{
  "_tag": "TokenStorageUnavailable"
}