Page Comparison

Versions Compared

Version	Old Version 4	New Version 5
Changes made by	Alvaro de la Serna Martinez	Alvaro de la Serna Martinez
Saved on	Nov 26, 2024	Nov 26, 2024

Key

This line was added.
This line was removed.
Formatting was changed.

minLevel

Table of Contents

minLevel	2
maxLevel	2
outline	false
type	flat
separator	brackets
printable	true

...

Endpoints and methods

Anchor
path1
path1
GET `/v2/accounts/{accountName}/tokens`

...

Successful response. List of tokens retrieved.

[ {

Expand

title	Request

Path parameters

Add the following path parameters as part of the endpoint:

Code

Description

200

Code Block

Parameter	Type	Description
`accountName` ^required	`string`	The name of the account.

Find below a request example:

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

Expand

title	Response

string

The name of the account.

Find below a request example:

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

Expand

title	Response

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

Path parameters

Add the following path parameters as part of the endpoint:

Find below a request example:

Expand

title	Request

Parameter

Type

Description

accountName ^required

string

The name of the account.

tokenId ^required

string

The ID of the token.

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

Expand

title	Response

Code

Description

200

Successful response. Token retrieved.

Code Block{ "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

Code

Description

200

Successful response. List of tokens retrieved.

Code Block

[
  {
    "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",
    "nametoken_type": "aBearer",
    "idactive": 1true,
    "scopeexpiration": "table://*.** level://admin2024-11-26T14:38:18.000+0000",
    "owneraccount": "web-testing+auto-admin@devo.comsampleAccount",
    "usercreated": "web2024-testing+auto-admin@devo.com11-25T14:38:18.000+0000",
    "audienceupdated": "apiv2-admin aggregations apiv22024-11-25T14:38:18.000+0000",
    "tokenexpires_in_typeseconds": "Bearer",86400
  },
 "active": true, {
    "expirationname": "2024-11-26T14:38:18.000+0000b",
    "accountid": "sampleAccount"2,
    "createdscope": "2024-11-25T14:38:18.000+0000table://*.** level://admin",
    "updatedowner": "2024web-11-25T14:38:18.000+0000",
    "expires_in_seconds": 86400
  },
  {
    "name": "btesting+auto-admin@devo.com",
    "user": "web-testing+auto-admin@devo.com",
    "idaudience": 2 "apiv2-admin aggregations apiv2",
    "scopetoken_type": "table://*.** level://admin"Bearer",
    "active": true,
    "ownerexpiration": "web2024-testing+auto-admin@devo.com11-26T14:38:18.000+0000",
    "useraccount": "web-testing+auto-admin@devo.comsampleAccount",
    "audiencecreated": "apiv2-admin aggregations apiv22024-11-25T14:38:18.000+0000",
    "token_typeupdated": "Bearer2024-11-25T14:38:18.000+0000",
    "activeexpires_in_seconds": true,86400
  }
]

4xx

Bad request.

Code Block

{
 "expiration": "2024-11-26T14:38:18.000+0000",error": {
    "accountcode": "sampleAccount"4xx,
    "createdmessage": "2024-11-25T14:38:18.000+0000",
    "updated": "2024-11-25T14:38:18.000+0000",
    "expires_in_seconds": 86400
  }
]

4xx

Bad request.

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

...

string"
  }
}

...

Anchor
path1
path1
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.

Expand

title	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:

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

Expand

title	Response

Code

Description

200

Successful response. Token retrieved.

Code Block

{
  "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-26T1425T14:38:18.000+0000",
  "token": "31089320378051f1a2ee17c14028f056","expires_in_seconds": 86400
}

4xx

Bad request.

Code Block
{ "error": { "accountcode": "sampleAccount"4xx, "createdmessage": "2024-11-25T14:38:18.000+0000",string" "updated": "2024-11-25T14:38:18.000+0000", "expires_in_seconds": 86400 }

4xx

Bad request.

}
}

...

Anchor
path2
path2
POST`/v2/accounts/{accountName}/tokens`

Creates a new token.

Payload:

Code Block
{ "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.

Expand

title	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:

Code Block
{ "

error

name": "string",

{

  "owner": "email",
  "

code

user":

4xx

"email",
  "audience": "string",
  "

message

scopes": "string",
  "

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:

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

Expand

title	Response

Code

Description

200

Successful response. Token created.

Code Block
{ TBD }

4xx

Bad request.

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

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

...

Anchor
path11
path11
PUT`/v2/accounts/{accountName}/tokens/{tokenId}/enable`

Enable token by ID

Expand

title	Request

Path parameters

Add the following path parameters as part of the endpoint:

Parameter	Type	Description

accountName


`accountName` ^required	`string`	The name of the account.
`tokenId` ^required	`string`	The

name

ID of the

account

token.

Find below a request example:

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

Expand

title	Response

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

Code	Description
200	Successful response. Token

created

enabled.

Code Block
{ TBD }

4xx

Bad request.

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

Info

...

Anchor
path11
path11
PUT`/`

...

`v2/`

...

`accounts/{`

...

`accountName}/`

...

`tokens/{`

...

`tokenId}/disable`

Disable token by ID

Query string parameters

Query string parameters are added after the path parameters, preceded by a question mark (?) and separated by an ampersand (&)

keepExisting

Request body

The request JSON body must include the following key-value pairs:

Find below a request example:

Expand

title	Request

Path parameters

Add the following path parameters as part of the endpoint:

Parameter	Type	Description

userEmail

accountName ^required

string

Enter the email

The name of the

required user

account.

domainName

tokenId ^required

string

Enter the name of the required domain. You must enter the full domain name using the format {domainName}@{resellerName}

Parameter

Type

Description

boolean

Set this to true to keep the current roles of the user, plus the new ones added through this request. The default value is false.

Parameter

Type

Description

roles ^required

object

Enter the list of role names separated by commas. Basic roles in Devo are:

OWNER
ADMIN
NO_PRIVILEGES

Custom roles must match the expression "^(([a-zA-Z0-9])+([ _-]))([a-zA-Z0-9])$".

Code Block
https://api-us.devo.com/probio/user/email/user@devo.com/domain/domainName@resellerName/role?keepExisting=true

And this is an example of a request body, including the required JSON object:

Code Block
[ "role1", "role2", "role3" ]

Expand

title	Response

Code

Description

200

Successful response. Roles updated.

4xx

Bad request.

The ID of the token.

Find below a request example:

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

Expand

title	Response

Code

Description

200

Successful response. Token disabled.

4xx

Bad request.

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

...

Anchor
path11
path11
PUT`/v2/accounts/{accountName}/tokens/{tokenId}/rename`

Enable token by ID

Expand

title	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:

Code Block
{ "

error

value":

{

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

...

Removes the indicated roles from the user in the specified domain.

Request body

The request JSON body must include the following key-value pairs:

Find below a request example:

Expand

title	Request

Path parameters

Add the following path parameters as part of the endpoint:

Parameter

Type

Description

userEmail ^required

string

Enter the email of the required user.

domainName ^required

string

Enter the name of the required domain. You must enter the full domain name using the format {domainName}@{resellerName}

Parameter

Type

Description

roles ^required

object

List of role names to be deleted, separated by commas. Basic roles in Devo are:

OWNER
ADMIN
NO_PRIVILEGES

Custom roles must match the expression "^(([a-zA-Z0-9])+([ _-]))([a-zA-Z0-9])$".

Code Block
https://api-us.devo.com/probio/user/email/user@devo.com/domain/domainName@resellerName/role

And this is an example of a request body, including the required JSON object:

Code Block
[ "role1", "role2", "role3" ]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:

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

Expand

title	Response

Code

Description

200

Successful response. Token renamed.

4xx

Bad request.

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

...

Anchor
path15
path15
DELETE`/v2/accounts/{accountName}/tokens/{tokenId}`

Deletes a token from an account.

Note
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.

Expand

title	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:

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

Expand

title	Response

Code	Description
200	Successful response.

Roles removed from user

Token deleted.

4xx

Bad request.

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

Page Comparison

Versions Compared

Key

Endpoints and methods

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

Path parameters

Path parameters

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

Path parameters

Anchorpath2path2 POST/v2/accounts/{accountName}/tokens

Path parameters

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

Path parameters

Anchorpath11path11 PUT/

v2/

accounts/{

accountName}/

tokens/{

tokenId}/disable

Path parameters

Query string parameters

Request body

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

Path parameters

Path parameters

Request body

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

Path parameters

Anchor
path1
path1
GET `/v2/accounts/{accountName}/tokens`

Anchor
path1
path1
GET `/v2/accounts/{accountName}/tokens/{tokenId}`

Anchor
path2
path2
POST`/v2/accounts/{accountName}/tokens`

Anchor
path11
path11
PUT`/v2/accounts/{accountName}/tokens/{tokenId}/enable`

Anchor
path11
path11
PUT`/`

`v2/`

`accounts/{`

`accountName}/`

`tokens/{`

`tokenId}/disable`

Anchor
path11
path11
PUT`/v2/accounts/{accountName}/tokens/{tokenId}/rename`

Anchor
path15
path15
DELETE`/v2/accounts/{accountName}/tokens/{tokenId}`