Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Overview

Check the list of available endpoints and methods to create and modify users using the Provisioning API.

Endpoints and methods

Description

GET /v2/accounts/{accountName}/tokens see below

Get a list of all the tokens for the provided account.

GET /v2/accounts/{accountName}/tokens/{tokenId} see below

Returns all the information of a single token, including the actual token.

POST /v2/accounts/{accountName}/tokens see below

Create a new token.

PUT /v2/accounts/{accountName}/tokens/{tokenId}/enable see below

Enable a token.

PUT /v2/accounts/{accountName}/tokens/{tokenId}/disable see below

Disable a token.

PUT /v2/accounts/{accountName}/tokens/{tokenId}/rename see below

Change the name associated with a token.

DELETE /v2/accounts/{accountName}/tokens/{tokenId} see below

Delete a token.

Endpoints and methods

GET /v2/accounts/{accountName}/tokens

Lists all the tokens for the provided account. This endpoint returns the information about the tokens and their IDs, but NOT the tokens themselves for security.

 Request

Path parameters

Add the following path parameters as part of the endpoint:

Parameter

Type

Description

accountName required

string

The name of the account.

Find below a request example:

https://api-us.devo.com/xxx/v2/accounts/sampleAccount/tokens
 Response

Code

Description

200

Successful response. List of tokens retrieved.

[
  {
    "name": "a",
    "id": 1,
    "scope": "table://*.** level://admin",
    "owner": "web-testing+auto-admin@devo.com",
    "user": "web-testing+auto-admin@devo.com",
    "audience": "apiv2-admin aggregations apiv2",
    "token_type": "Bearer",
    "active": true,
    "expiration": "2024-11-26T14:38:18.000+0000",
    "account": "sampleAccount",
    "created": "2024-11-25T14:38:18.000+0000",
    "updated": "2024-11-25T14:38:18.000+0000",
    "expires_in_seconds": 86400
  },
  {
    "name": "b",
    "id": 2,
    "scope": "table://*.** level://admin",
    "owner": "web-testing+auto-admin@devo.com",
    "user": "web-testing+auto-admin@devo.com",
    "audience": "apiv2-admin aggregations apiv2",
    "token_type": "Bearer",
    "active": true,
    "expiration": "2024-11-26T14:38:18.000+0000",
    "account": "sampleAccount",
    "created": "2024-11-25T14:38:18.000+0000",
    "updated": "2024-11-25T14:38:18.000+0000",
    "expires_in_seconds": 86400
  }
]

4xx

Bad request.

{
  "error": {
    "code": 4xx,
    "message": "string"
  }
}

GET /v2/accounts/{accountName}/tokens/{tokenId}

Returns the full information on a single token, identified by its ID. The response to this request includes the actual token.

 Request

Path parameters

Add the following path parameters as part of the endpoint:

Parameter

Type

Description

accountName required

string

The name of the account.

tokenId required

string

The ID of the token.

Find below a request example:

https://api-us.devo.com/xxx/v2/accounts/sampleAccount/tokens/3
 Response

Code

Description

200

Successful response. Token retrieved.

{
  "name": "test",
  "id": 3,
  "scope": "table://*.** level://admin",
  "owner": "web-testing+auto-admin@devo.com",
  "user": "web-testing+auto-admin@devo.com",
  "audience": "apiv2-admin aggregations apiv2",
  "token_type": "Bearer",
  "active": true,
  "expiration": "2024-11-26T14:38:18.000+0000",
  "token": "31089320378051f1a2ee17c14028f056",
  "account": "sampleAccount",
  "created": "2024-11-25T14:38:18.000+0000",
  "updated": "2024-11-25T14:38:18.000+0000",
  "expires_in_seconds": 86400
}

4xx

Bad request.

{
  "error": {
    "code": 4xx,
    "message": "string"
  }
}

POST /v2/accounts/{accountName}/tokens

Creates a new token.

 Request

Path parameters

Add the following path parameters as part of the endpoint:

Parameter

Type

Description

accountName required

string

The name of the account.

Payload:

{
  "name": "string",
  "owner": "email",
  "user": "email",
  "audience": "string",
  "scopes": "string",
  "expiresInSeconds": 86400
}

  • name is optional, and defaults to 'Unnamed' when not present.

  • user is optional and only required when a user is creating a token on behalf of another user. The credentials are resolved for the value of this field (which defaults to the owner when not present).

  • audience is required (samples: apiv2, apiv2-admin, alerts, aggregations, http).

  • scopes is optional and defaults to 'default' when not present.

  • expiresInSeconds is optional and defaults to 86400 when not present. Use the value -1 to create a permanent token.

Find below a request example:

https://api-us.devo.com/xxx/v2/accounts/sampleAccount/tokens
 Response

Code

Description

200

Successful response. Token created.

{
  TBD
}

4xx

Bad request.

{
  "error": {
    "code": 4xx,
    "message": "string"
  }
}

Creating a token returns the location header with the URI where the resource can be located.

PUT /v2/accounts/{accountName}/tokens/{tokenId}/enable

Enable token by ID

 Request

Path parameters

Add the following path parameters as part of the endpoint:

Parameter

Type

Description

accountName required

string

The name of the account.

tokenId required

string

The ID of the token.

Find below a request example:

https://api-us.devo.com/xxx/v2/accounts/sampleAccount/tokens/3/enable
 Response

Code

Description

200

Successful response. Token enabled.

4xx

Bad request.

{
  "error": {
    "code": 4xx,
    "message": "string"
  }
}

PUT /v2/accounts/{accountName}/tokens/{tokenId}/disable

Disable token by ID

 Request

Path parameters

Add the following path parameters as part of the endpoint:

Parameter

Type

Description

accountName required

string

The name of the account.

tokenId required

string

The ID of the token.

Find below a request example:

https://api-us.devo.com/xxx/v2/accounts/sampleAccount/tokens/3/disable
 Response

Code

Description

200

Successful response. Token disabled.

4xx

Bad request.

{
  "error": {
    "code": 4xx,
    "message": "string"
  }
}

PUT /v2/accounts/{accountName}/tokens/{tokenId}/rename

Enable token by ID

 Request

Path parameters

Add the following path parameters as part of the endpoint:

Parameter

Type

Description

accountName required

string

The name of the account.

tokenId required

string

The ID of the token.

Payload:

{
  "value": "your new token name"
}

If the new name is empty or null, the service will still return OK, but the token name will remain unchanged.

Find below a request example:

https://api-us.devo.com/xxx/v2/accounts/sampleAccount/tokens/3/rename
 Response

Code

Description

200

Successful response. Token renamed.

4xx

Bad request.

{
  "error": {
    "code": 4xx,
    "message": "string"
  }
}

DELETE /v2/accounts/{accountName}/tokens/{tokenId}

Deletes a token from an account.

Only to be used when the token is to be removed from the service. There is no coming back from this, and once a token is deleted then it's gone for good.

 Request

Path parameters

Add the following path parameters as part of the endpoint:

Parameter

Type

Description

accountName required

string

The name of the account.

tokenId required

string

The ID of the token.

Find below a request example:

https://api-us.devo.com/xxx/v2/accounts/sampleAccount/tokens/3
 Response

Code

Description

200

Successful response. Token deleted.

4xx

Bad request.

{
  "error": {
    "code": 4xx,
    "message": "string"
  }
}
  • No labels