Create account API token

POST 
/bv/account/v1/accounts/api-token

Generates an API token associated with the current user's account. When invoking an API using this token (with some exceptions detailed in the API documentation), the x-bv-org-id must be included in the header to specify the organization.

Notice: The endpoint /bv/account/v1/accounts/api-token will be deprecated soon. Please use /bv/account/v1/accounts/api-tokens instead.

Request

application/json

Body

required

name stringrequired

Required. The display name of api token.

expired_date date-time

Optional. The expired date of api token. Format: ISO8601 If the expiration date is empty, the API token will not expire.

Responses

200

A successful response.

application/json

Schema

Schema

token string

Output only.

expired_date date-time

Output only. The expired date of token.

token_type Output only. The type of api token. (e.g. Basic,Bearer) Default: Bearer (string)
id string

Output only. The resource identifier of API token.

Example (from schema)

{
  "expired_date": "2023-06-09T02:22:51.320Z",
  "id": "15e5910b-ef36-4288-9b14-31adb324cf7a",
  "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl91c2UiOiJhcGlfYWNjZXNzIiwiZW1haWwiOiJnYXJ5dGFuQGtrY29tcGFueS5jb20iLCJpc3MiOiJvcmJpdCIsInN1YiI6IjE3NjI5OGM2LWM1OTktNDQzNS05NjczLWU4YjYzZGJkMWFiNyIsImV4cCI6MTY4NjI3NzM3MSwianRpIjoiMzZmZmUyOWUtOTY1Ni00Yzc2LTlkMWEtN2YwMWNhOGY3NzA1In0.oK72sYjOQlpri5mDEGWtkLyycFJsDxoNDml3S93_qEsQ5x0eeRqazn-cHsJlvMscdgv9qFfL-iHgRQONQpAExQPao_ZInYr7p-S8Tk7eIq_MbarlN1z2MWEA-iPfEO2XK79V8fVbv5_XzKywMMwlUIvLQMPo29nniPhCiPL3VOwrk83pGjofpHmwpVUgCkqmNIqqrGhuuVUOk4_8PlhnOsXHstiO4kav8p-bKdj9oR6GdVWNAR0PSIqEJhvgsAvLD5BNN80jkY8Cp7aUMO2f88saKzPn0XDE1G8Jr01FujcE1CEnfaniL5xS5Gef_05eHQAn2tTykMqb0E2H3Mpz5UgftsnSV3vKb8WQ7Bk8p9KaElD0-WIiRn1pQVMFRaQ424Gg0Xzi99wyNTKMe-QaFWOuEWl8RQQFXJswjf8g5kxVbq6vLaNB9s-ZF1jsH0onUtxxjcBmRwbAUEo0WT_9KG-qehP4_KPAx0V8lrRmaWh3nYs-WGwZaeQ48C8NDam2IRZcnyS0lzte6pB4YcXDk7unYlvi230PnP3TC6T23B2A9rHAgUruPt3o2GBBxf2wo0_9Io6zUv0oe0saEIvyn1KcuWuAo68-s-e-_YxJ4xvAd0UoBpNhPjiSLiFXWmx56_z5Umk6smmG-cVD4sjk_GIjR17z2I1yeFs2PTv1IlQ",
  "token_type": "Bearer"
}

400

A bad request response. The code is 3 means got an invalid argument. There are more HTTP status code mappings listed on here and gRPC code on here.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

401

A unauthenticated response. The header authorization was missing or unidentified.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

403

A forbidden response. It means that the provided authorization did not have enough permission to access the resource or the API.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

500

A server error response. There are more HTTP status code mappings listed on here.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...