Management APIs

GUI Management

You can manage your tenant either from the Object storage Portal on the following link after logging in to your account, Object Storage Portal

Or you can manage your tenant through the API Gateway using the following API calls

The following are examples for each Tenant Management API call.

API Gateway

https://api-object.bluvalt.com/api/v3/

Authorization

Operations on authorization

Generate AUTH Token POST /authorize

Get authorization token

curl -X POST "https://api-object.bluvalt.com/api/v3/authorize" -H "accept: application/json" -H "Content-Type: application/json" -H "X-Csrf-Token: a5445566b3c968014503d74a31fc4850" -d "{ \"accountId\": \"45560305624791037332\", \"username\": \"UserName\", \"password\": \"YourPassword\", \"cookie\": true, \"csrfToken\": false}"

Response body

{
  "responseTime": "2019-07-17T13:05:11.630Z",
  "status": "success",
  "apiVersion": "3.0",
  "data": "e759460f-96c8-4eb6-8dff-94e0730e5572"
}

Response headers

 api-version: 3 
 cache-control: private, no-cache, max-age=57598 
 connection: Keep-Alive 
 content-length: 128 
 content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
 content-type: application/json 
 date: Wed, 17 Jul 2019 13:05:11 GMT 
 expires: Thu, 18 Jul 2019 05:05:09 GMT 
 keep-alive: timeout=5, max=99 
 server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
 strict-transport-security: max-age=31536000; includeSubDomains 
 vary: Api-Version 
 x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
 x-content-type-options: nosniff 
 x-frame-options: SAMEORIGIN 
 x-xss-protection: 1 
Delete AUTH Token DELETE /authorize

Delete authorization token

curl -X DELETE "https://api-object.bluvalt.com/api/v3/authorize" -H "accept: application/json" -H "Authorization: Bearer e759460f-96c8-4eb6-8dff-94e0730e5572" -H "X-Csrf-Token: a5445566b3c968014503d74a31fc4850"

Account

Operations on the current Storage Tenant Account

Get Usage GET /org/usage

Gets the storage usage information for the current Storage Tenant Account

curl -X GET "https://api-object.bluvalt.com/api/v3/org/usage" -H "accept: application/json" -H "Authorization: Bearer 4be647c5-def8-40b6-8566-16b919c46e16"

Response body

{
  "responseTime": "2019-07-18T08:27:12.118Z",
  "status": "success",
  "apiVersion": "3.0",
  "data": {
    "calculationTime": "2019-07-18T08:27:12.121413Z",
    "objectCount": 0,
    "dataBytes": 0,
    "buckets": []
  }
}

Response headers

api-version: 3 
cache-control: private, no-cache, max-age=0 
connection: Keep-Alive 
content-length: 182 
content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
content-type: application/json 
date: Thu, 18 Jul 2019 08:27:12 GMT 
expires: Thu, 18 Jul 2019 08:27:12 GMT 
keep-alive: timeout=5, max=100 
server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
strict-transport-security: max-age=31536000; includeSubDomains 
vary: Api-Version 
x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
x-content-type-options: nosniff 
x-frame-options: SAMEORIGIN 
x-xss-protection: 1 

Compliance

Operations on compliance

Get Compliance GET /org/compliance-global

Retrieves the global compliance settings

curl -X GET "https://api-object.bluvalt.com/api/v3/org/compliance-global" -H "accept: application/json" -H "Authorization: Bearer 7ec5b12a-8abd-4243-8b90-5a258fee0f18"

Response body

{
  "responseTime": "2019-07-17T13:19:23.397Z",
  "status": "success",
  "apiVersion": "3.0",
  "data": {
    "complianceEnabled": false
  }
}

Response headers

 api-version: 3 
 cache-control: private, no-cache, max-age=0 
 connection: Keep-Alive 
 content-length: 117 
 content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
 content-type: application/json 
 date: Wed, 17 Jul 2019 13:19:23 GMT 
 expires: Wed, 17 Jul 2019 13:19:23 GMT 
 keep-alive: timeout=5, max=100 
 server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
 strict-transport-security: max-age=31536000; includeSubDomains 
 vary: Api-Version 
 x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
 x-content-type-options: nosniff 
 x-frame-options: SAMEORIGIN 
 x-xss-protection: 1 

Config

Operations on version or session information

Get Config GET /org/config

Retrieves global configuration and token information

curl -X GET "https://api-object.bluvalt.com/api/v3/org/config" -H "accept: application/json" -H "Authorization: Bearer 7ec5b12a-8abd-4243-8b90-5a258fee0f18"

Response body

{
  "responseTime": "2019-07-17T13:20:32.286Z",
  "status": "success",
  "apiVersion": "3.0",
  "data": {
    "auto-logout": 9000,
    "user": {
      "id": "2ed26afd-e109-4733-9e66-da99771012a2",
      "username": "test",
      "uniqueName": "user/test",
      "firstName": "test",
      "fullName": "test",
      "federated": false
    },
    "token": {
      "expires": "2019-07-18T05:11:47.000Z"
    },
    "permissions": {
      "rootAccess": true
    },
    "deactivatedFeatures": {},
    "account": {
      "id": "45560305624791037332",
      "name": "API-GW-Demo",
      "capabilities": [
        "management",
        "s3"
      ],
      "policy": {
        "useAccountIdentitySource": true,
        "allowPlatformServices": true,
        "quotaObjectBytes": null
      }
    }
  }
}

Response headers

 api-version: 3 
 cache-control: private, no-cache, max-age=0 
 connection: Keep-Alive 
 content-length: 559 
 content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
 content-type: application/json 
 date: Wed, 17 Jul 2019 13:20:32 GMT 
 expires: Wed, 17 Jul 2019 13:20:32 GMT 
 keep-alive: timeout=5, max=98 
 server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
 strict-transport-security: max-age=31536000; includeSubDomains 
 vary: Api-Version 
 x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
 x-content-type-options: nosniff 
 x-frame-options: SAMEORIGIN 
 x-xss-protection: 1 
Get Config Product Version GET /org/config/product-version

Retrieves the product release version

curl -X GET "https://api-object.bluvalt.com/api/v3/org/config/product-version" -H "accept: application/json" -H "Authorization: Bearer 7ec5b12a-8abd-4243-8b90-5a258fee0f18"

Response body

{
"responseTime": "2019-07-17T13:21:09.583Z",
"status": "success",
"apiVersion": "3.0",
"data": {
"productVersion": "11.2.0.2-20190522.1810.2ecb871"
}
}

Response headers

api-version: 3 
cache-control: private, no-cache, max-age=0 
connection: Keep-Alive 
content-length: 141 
content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
content-type: application/json 
date: Wed, 17 Jul 2019 13:21:09 GMT 
expires: Wed, 17 Jul 2019 13:21:09 GMT 
keep-alive: timeout=5, max=100 
server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
strict-transport-security: max-age=31536000; includeSubDomains 
vary: Api-Version 
x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
x-content-type-options: nosniff 
x-frame-options: SAMEORIGIN 
x-xss-protection: 1 
API Versions GET /versions

Retrieves the major versions of the management API supported by the product release

curl -X GET "https://api-object.bluvalt.com/api/v3/versions" -H "accept: application/json" -H "Authorization: Bearer 7ec5b12a-8abd-4243-8b90-5a258fee0f18"

Response body

{
  "responseTime": "2019-07-17T13:21:58.681Z",
  "status": "success",
  "apiVersion": "3.0",
  "data": [
    2,
    3
  ]
}

Response headers

api-version: 3 
cache-control: private, no-cache, max-age=0 
connection: Keep-Alive 
content-length: 95 
content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
content-type: application/json 
date: Wed, 17 Jul 2019 13:21:58 GMT 
expires: Wed, 17 Jul 2019 13:21:58 GMT 
keep-alive: timeout=5, max=100 
server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
strict-transport-security: max-age=31536000; includeSubDomains 
vary: Api-Version 
x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
x-content-type-options: nosniff 
x-frame-options: SAMEORIGIN 
x-xss-protection: 1 

Containers

Operations on S3 buckets or Swift containers

List Buckets or Containetrs /org/containers

Lists the S3 buckets or Swift containers for a tenant account

curl -X GET "https://api-object.bluvalt.com/api/v3/org/containers?include=compliance" -H "accept: application/json" -H "Authorization: Bearer 12128f87-4399-4ebb-b29c-b4486a37d043" -H "X-Csrf-Token: 0ebc18baf2069e1d2168d01d7052dd50"

Response body

{
  "responseTime": "2019-07-22T08:52:39.182Z",
  "status": "success",
  "apiVersion": "3.0",
  "data": [
    {
      "name": "demobucket",
      "creationTime": "2019-07-22T08:12:51.703Z"
    }
  ]
}

Response headers

api-version: 3 
cache-control: private, no-cache, max-age=0 
connection: Keep-Alive 
content-length: 155 
content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
content-type: application/json 
date: Mon, 22 Jul 2019 08:52:39 GMT 
expires: Mon, 22 Jul 2019 08:52:38 GMT 
keep-alive: timeout=5, max=100 
server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
strict-transport-security: max-age=31536000; includeSubDomains 
vary: Api-Version 
x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
x-content-type-options: nosniff 
x-frame-options: SAMEORIGIN 
x-xss-protection: 1 
Create Buckets or Containers /org/containers

Create a bucket for an S3 tenant account

curl -X POST "https://api-object.bluvalt.com/api/v3/org/containers" -H "accept: application/json" -H "Content-Type: application/json" -H "X-Csrf-Token: 0ebc18baf2069e1d2168d01d7052dd50" -d "{ \"name\": \"demobucket01\"}"

Response body

{
  "code": 201,
  "responseTime": "2019-07-22T08:57:35.853Z",
  "status": "success",
  "apiVersion": "3.0",
  "data": {
    "name": "demobucket01"
  }
}

Response headers

api-version: 3 
cache-control: private, no-cache, max-age=0 
connection: Keep-Alive 
content-length: 124 
content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
content-type: application/json 
date: Mon, 22 Jul 2019 08:57:35 GMT 
expires: Mon, 22 Jul 2019 08:57:35 GMT 
keep-alive: timeout=5, max=99 
server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
strict-transport-security: max-age=31536000; includeSubDomains 
vary: Api-Version 
x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
x-content-type-options: nosniff 
x-frame-options: SAMEORIGIN 
x-xss-protection: 1 
Get Consistinsy Level for a Bucket or Container /org/containers/{containerName}/consistency

Gets the consistency level for an S3 bucket or Swift container

curl -X GET "https://api-object.bluvalt.com/api/v3/org/containers/demobucket/consistency" -H "accept: application/json" -H "X-Csrf-Token: 0ebc18baf2069e1d2168d01d7052dd50"

Response body

{
  "responseTime": "2019-07-22T09:00:27.794Z",
  "status": "success",
  "apiVersion": "3.0",
  "data": {
    "consistency": "read-after-new-write"
  }
}

Response headers

api-version: 3 
cache-control: private, no-cache, max-age=0 
connection: Keep-Alive 
content-length: 128 
content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
content-type: application/json 
date: Mon, 22 Jul 2019 09:00:27 GMT 
expires: Mon, 22 Jul 2019 09:00:27 GMT 
keep-alive: timeout=5, max=100 
server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
strict-transport-security: max-age=31536000; includeSubDomains 
vary: Api-Version 
x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
x-content-type-options: nosniff 
x-frame-options: SAMEORIGIN 
x-xss-protection: 1 
Set Consistinsy Level for a Bucket or Container /org/containers/{containerName}/consistency

Sets the consistency level for an S3 bucket or Swift container

curl -X PUT "https://api-object.bluvalt.com/api/v3/org/containers/demobucket/consistency" -H "accept: application/json" -H "Content-Type: application/json" -H "X-Csrf-Token: 0ebc18baf2069e1d2168d01d7052dd50" -d "{ \"consistency\": \"available\"}"

Response body

{
  "responseTime": "2019-07-22T09:01:51.138Z",
  "status": "success",
  "apiVersion": "3.0",
  "data": {
    "consistency": "available"
  }
}

Response headers

 api-version: 3 
 cache-control: private, no-cache, max-age=0 
 connection: Keep-Alive 
 content-length: 117 
 content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
 content-type: application/json 
 date: Mon, 22 Jul 2019 09:01:51 GMT 
 expires: Mon, 22 Jul 2019 09:01:51 GMT 
 keep-alive: timeout=5, max=100 
 server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
 strict-transport-security: max-age=31536000; includeSubDomains 
 vary: Api-Version 
 x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
 x-content-type-options: nosniff 
 x-frame-options: SAMEORIGIN 
 x-xss-protection: 1 
Get a Bucket CORS /org/containers/{bucketName}/cors

Gets the Cross-Origin Resource Sharing (CORS) configuration for an S3 bucket

curl -X GET "https://api-object.bluvalt.com/api/v3/org/containers/demobucket/cors" -H "accept: application/json" -H "X-Csrf-Token: 0ebc18baf2069e1d2168d01d7052dd50"

Response body

{
  "responseTime": "2019-07-22T09:03:33.146Z",
  "status": "success",
  "apiVersion": "3.0",
  "data": {
    "cors": "<CORSConfiguration>\n  <CORSRule>\n    <AllowedOrigin>http://www.example.com</AllowedOrigin>\n    <AllowedMethod>GET</AllowedMethod>\n  </CORSRule>\n</CORSConfiguration>"
  }
}

Response headers

 api-version: 3 
 cache-control: private, no-cache, max-age=0 
 connection: Keep-Alive 
 content-length: 350 
 content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
 content-type: application/json 
 date: Mon, 22 Jul 2019 09:03:33 GMT 
 expires: Mon, 22 Jul 2019 09:03:33 GMT 
 keep-alive: timeout=5, max=99 
 server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
 strict-transport-security: max-age=31536000; includeSubDomains 
 vary: Api-Version 
 x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
 x-content-type-options: nosniff 
 x-frame-options: SAMEORIGIN 
 x-xss-protection: 1 
Set a Bucket CORS /org/containers/{bucketName}/cors

Sets the Cross-Origin Resource Sharing (CORS) configuration for an S3 bucket

curl -X PUT "https://api-object.bluvalt.com/api/v3/org/containers/demobucket/cors" -H "accept: application/json" -H "Content-Type: application/json" -H "X-Csrf-Token: 0ebc18baf2069e1d2168d01d7052dd50" -d "{ \"cors\": \"<CORSConfiguration>\ <CORSRule>\ <AllowedOrigin>http://www.example.com</AllowedOrigin>\ <AllowedMethod>GET</AllowedMethod>\ </CORSRule>\</CORSConfiguration>\\"}"

Response body

{
  "responseTime": "2019-07-22T09:05:57.184Z",
  "status": "success",
  "apiVersion": "3.0",
  "data": {
    "cors": "<CORSConfiguration>\n  <CORSRule>\n    <AllowedOrigin>http://www.example.com</AllowedOrigin>\n    <AllowedMethod>GET</AllowedMethod>\n  </CORSRule>\n</CORSConfiguration>\n"
  }
}

Response headers

api-version: 3 
cache-control: private, no-cache, max-age=0 
connection: Keep-Alive 
content-length: 352 
content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
content-type: application/json 
date: Mon, 22 Jul 2019 09:05:57 GMT 
expires: Mon, 22 Jul 2019 09:05:47 GMT 
keep-alive: timeout=5, max=100 
server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
strict-transport-security: max-age=31536000; includeSubDomains 
vary: Api-Version 
x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
x-content-type-options: nosniff 
x-frame-options: SAMEORIGIN 
x-xss-protection: 1 
Get Last Access Time Status /org/containers/{bucketName}/last-access-time

Determines if last access time is enabled for an S3 bucket

curl -X GET "https://api-object.bluvalt.com/api/v3/org/containers/demobucket/last-access-time" -H "accept: application/json" -H "X-Csrf-Token: 0ebc18baf2069e1d2168d01d7052dd50"

Response body

{
  "responseTime": "2019-07-22T09:08:06.452Z",
  "status": "success",
  "apiVersion": "3.0",
  "data": {
    "lastAccessTime": "disabled"
  }
}

Response headers

 api-version: 3 
 cache-control: private, no-cache, max-age=0 
 connection: Keep-Alive 
 content-length: 118 
 content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
 content-type: application/json 
 date: Mon, 22 Jul 2019 09:08:06 GMT 
 expires: Mon, 22 Jul 2019 09:08:06 GMT 
 keep-alive: timeout=5, max=100 
 server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
 strict-transport-security: max-age=31536000; includeSubDomains 
 vary: Api-Version 
 x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
 x-content-type-options: nosniff 
 x-frame-options: SAMEORIGIN 
 x-xss-protection: 1 
Set Last Access Time Status /org/containers/{bucketName}/last-access-time

Enables or disables last access time updates for an S3 bucket

curl -X PUT "https://api-object.bluvalt.com/api/v3/org/containers/demobucket/last-access-time" -H "accept: application/json" -H "Content-Type: application/json" -H "X-Csrf-Token: 0ebc18baf2069e1d2168d01d7052dd50" -d "{ \"lastAccessTime\": \"enabled\"}"

Response body

{
  "responseTime": "2019-07-22T09:08:00.064Z",
  "status": "success",
  "apiVersion": "3.0",
  "data": {
    "lastAccessTime": "enabled"
  }
}

Response headers

api-version: 3 
cache-control: private, no-cache, max-age=0 
connection: Keep-Alive 
content-length: 118 
content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
content-type: application/json 
date: Mon, 22 Jul 2019 09:08:00 GMT 
expires: Mon, 22 Jul 2019 09:07:59 GMT 
keep-alive: timeout=5, max=100 
server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
strict-transport-security: max-age=31536000; includeSubDomains 
vary: Api-Version 
x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
x-content-type-options: nosniff 
x-frame-options: SAMEORIGIN 
x-xss-protection: 1 
Get Metadata Notification /org/containers/{bucketName}/metadata-notification

Gets the metadata notification (search) configuration for an S3 bucket

curl -X GET "https://api-object.bluvalt.com/api/v3/org/containers/demobucket/metadata-notification" -H "accept: application/json" -H "X-Csrf-Token: 0ebc18baf2069e1d2168d01d7052dd50"

Response body

{
  "responseTime": "2019-07-22T09:11:26.559Z",
  "status": "success",
  "apiVersion": "3.0",
  "data": {
    "metadataNotification": null
  }
}

Response headers

 api-version: 3 
 cache-control: private, no-cache, max-age=0 
 connection: Keep-Alive 
 content-length: 119 
 content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
 content-type: application/json 
 date: Mon, 22 Jul 2019 09:11:26 GMT 
 expires: Mon, 22 Jul 2019 09:11:26 GMT 
 keep-alive: timeout=5, max=100 
 server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
 strict-transport-security: max-age=31536000; includeSubDomains 
 vary: Api-Version 
 x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
 x-content-type-options: nosniff 
 x-frame-options: SAMEORIGIN 
 x-xss-protection: 1 
Set Metadata Notification /org/containers/{bucketName}/metadata-notification

Sets the metadata notification (search) configuration for an S3 bucket

curl -X PUT "https://api-object.bluvalt.com/api/v3/org/containers/demobucket/metadata-notification" -H "accept: application/json" -H "Content-Type: application/json" -H "X-Csrf-Token: 0ebc18baf2069e1d2168d01d7052dd50" -d "{ \"metadataNotification\": \"<MetadataNotificationConfiguration>\ <Rule>\ <ID>Rule-1</ID>\ <Status>Enabled</Status>\ <Prefix></Prefix>\ <Destination>\ <Urn>arn:aws:es:us-east-1:3333333:domain-name</Urn>\ </Destination>\ </Rule>\</MetadataNotificationConfiguration>\\"}"

Response body

{
  "responseTime": "2019-07-22T09:13:57.240Z",
  "status": "success",
  "apiVersion": "3.0",
  "deprecated": false,
  "data": {
    "metadataNotification": "<MetadataNotificationConfiguration>\n  <Rule>\n      <ID>Rule-1</ID>\n      <Status>Enabled</Status>\n      <Prefix></Prefix>\n      <Destination>\n         <Urn>arn:aws:es:us-east-1:3333333:domain-name</Urn>\n      </Destination>\n  </Rule>\n</MetadataNotificationConfiguration>\n"
  }
}

Response headers

api-version: 3 
cache-control: private, no-cache, max-age=0 
connection: close 
content-length: 1473 
content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
content-type: application/json 
date: Mon, 22 Jul 2019 09:13:58 GMT 
expires: Mon, 22 Jul 2019 09:13:58 GMT 
server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
strict-transport-security: max-age=31536000; includeSubDomains 
vary: Api-Version 
x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
x-content-type-options: nosniff 
x-frame-options: SAMEORIGIN 
x-xss-protection: 1 
Get Bucket Notification /org/containers/{bucketName}/notification

Gets the notification configuration for an S3 bucket

curl -X GET "https://api-object.bluvalt.com/api/v3/org/containers/demobucket/notification" -H "accept: application/json" -H "X-Csrf-Token: 0ebc18baf2069e1d2168d01d7052dd50"

Response body

{
  "responseTime": "2019-07-22T09:17:04.493Z",
  "status": "success",
  "apiVersion": "3.0",
  "data": {
    "notification": null
  }
}

Response headers

 api-version: 3 
 cache-control: private, no-cache, max-age=0 
 connection: Keep-Alive 
 content-length: 111 
 content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
 content-type: application/json 
 date: Mon, 22 Jul 2019 09:17:04 GMT 
 expires: Mon, 22 Jul 2019 09:17:04 GMT 
 keep-alive: timeout=5, max=100 
 server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
 strict-transport-security: max-age=31536000; includeSubDomains 
 vary: Api-Version 
 x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
 x-content-type-options: nosniff 
 x-frame-options: SAMEORIGIN 
 x-xss-protection: 1 
Set Bucket Notification /org/containers/{bucketName}/notification

Sets the notification configuration for an S3 bucket

curl -X PUT "https://api-object.bluvalt.com/api/v3/org/containers/demobucket/notification" -H "accept: application/json" -H "Content-Type: application/json" -H "X-Csrf-Token: 0ebc18baf2069e1d2168d01d7052dd50" -d "{ \"notification\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\<NotificationConfiguration xmlns=\\\"http://s3.amazonaws.com/doc/2006-03-01/\\\">\ <TopicConfiguration>\ <Id>MyEventForPut</Id>\ <Topic>arn:aws:sns:us-east-1:050340950352:my-topic</Topic>\ <Event>s3:ObjectCreated:Put</Event>\ <Filter>\ <S3Key>\ <FilterRule>\ <Name>prefix</Name>\ <Value>images/</Value>\ </FilterRule>\ <FilterRule>\ <Name>suffix</Name>\ <Value>.jpg</Value>\ </FilterRule>\ </S3Key>\ </Filter>\ </TopicConfiguration>\</NotificationConfiguration>\\"}"

Response body

{
  "responseTime": "2019-07-22T09:18:42.947Z",
  "status": "success",
  "apiVersion": "3.0",
  "deprecated": false,
  "data": {
    "notification": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<NotificationConfiguration xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">\n  <TopicConfiguration>\n    <Id>MyEventForPut</Id>\n    <Topic>arn:aws:sns:us-east-1:050340950352:my-topic</Topic>\n    <Event>s3:ObjectCreated:Put</Event>\n    <Filter>\n      <S3Key>\n        <FilterRule>\n          <Name>prefix</Name>\n          <Value>images/</Value>\n        </FilterRule>\n        <FilterRule>\n          <Name>suffix</Name>\n          <Value>.jpg</Value>\n        </FilterRule>\n      </S3Key>\n    </Filter>\n  </TopicConfiguration>\n</NotificationConfiguration>\n"
  }
}

Response headers

api-version: 3 
cache-control: private, no-cache, max-age=0 
connection: close 
content-length: 1440 
content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
content-type: application/json 
date: Mon, 22 Jul 2019 09:18:44 GMT 
expires: Mon, 22 Jul 2019 09:18:44 GMT 
server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
strict-transport-security: max-age=31536000; includeSubDomains 
vary: Api-Version 
x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
x-content-type-options: nosniff 
x-frame-options: SAMEORIGIN 
x-xss-protection: 1 
Get Bucket Replication /org/containers/{bucketName}/replication

Gets the replication configuration for an S3 bucket

curl -X GET "https://api-object.bluvalt.com/api/v3/org/containers/demobucket/replication" -H "accept: application/json" -H "X-Csrf-Token: 0ebc18baf2069e1d2168d01d7052dd50"

Response body

{
  "responseTime": "2019-07-22T09:20:56.806Z",
  "status": "success",
  "apiVersion": "3.0",
  "data": {
    "replication": null
  }
}

Response headers

 api-version: 3 
 cache-control: private, no-cache, max-age=0 
 connection: Keep-Alive 
 content-length: 110 
 content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
 content-type: application/json 
 date: Mon, 22 Jul 2019 09:20:56 GMT 
 expires: Mon, 22 Jul 2019 09:20:56 GMT 
 keep-alive: timeout=5, max=100 
 server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
 strict-transport-security: max-age=31536000; includeSubDomains 
 vary: Api-Version 
 x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
 x-content-type-options: nosniff 
 x-frame-options: SAMEORIGIN 
 x-xss-protection: 1 
Set Bucket Replication /org/containers/{bucketName}/replication

Sets the replication configuration for an S3 bucket

curl -X PUT "https://api-object.bluvalt.com/api/v3/org/containers/demobucket/replication" -H "accept: application/json" -H "Content-Type: application/json" -H "X-Csrf-Token: 0ebc18baf2069e1d2168d01d7052dd50" -d "{ \"replication\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\<ReplicationConfiguration xmlns=\\\"http://s3.amazonaws.com/doc/2006-03-01/\\\">\ <Rule>\ <ID>rule1</ID>\ <Status>Enabled</Status>\ <Prefix></Prefix>\ <Destination>\ <Bucket>arn:aws:s3:::mybucket-replicated</Bucket>\ <StorageClass>STANDARD</StorageClass>\ </Destination>\ <Role>arn:aws:iam::35667example:role/CrossRegionReplicationRoleForS3</Role>\ </Rule>\</ReplicationConfiguration>\\"}"

Response body

{
  "responseTime": "2019-07-22T09:23:03.422Z",
  "status": "success",
  "apiVersion": "3.0",
  "deprecated": false,
  "data": {
    "replication": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ReplicationConfiguration xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">\n  <Rule>\n    <ID>rule1</ID>\n    <Status>Enabled</Status>\n    <Prefix></Prefix>\n    <Destination>\n      <Bucket>arn:aws:s3:::mybucket-replicated</Bucket>\n      <StorageClass>STANDARD</StorageClass>\n    </Destination>\n    <Role>arn:aws:iam::35667example:role/CrossRegionReplicationRoleForS3</Role>\n  </Rule>\n</ReplicationConfiguration>\n"
  }
}

Response headers

api-version: 3 
cache-control: private, no-cache, max-age=0 
connection: close 
content-length: 1425 
content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
content-type: application/json 
date: Mon, 22 Jul 2019 09:23:05 GMT 
expires: Mon, 22 Jul 2019 09:23:04 GMT 
server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
strict-transport-security: max-age=31536000; includeSubDomains 
vary: Api-Version 
x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
x-content-type-options: nosniff 
x-frame-options: SAMEORIGIN 
x-xss-protection: 1 

###Features Operations on features

Deactivated Features GET /org/deactivated-features

Operations on deactivated features

curl -X GET "https://api-object.bluvalt.com/api/v3/org/deactivated-features" -H "accept: application/json" -H "Authorization: Bearer 7ec5b12a-8abd-4243-8b90-5a258fee0f18"

Response body

{
  "responseTime": "2019-07-17T13:23:33.995Z",
  "status": "success",
  "apiVersion": "3.0",
  "data": {}
}

Response headers api-version: 3

 cache-control: private, no-cache, max-age=0 
 connection: Keep-Alive 
 content-length: 92 
 content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
 content-type: application/json 
 date: Wed, 17 Jul 2019 13:23:33 GMT 
 expires: Wed, 17 Jul 2019 13:23:33 GMT 
 keep-alive: timeout=5, max=98 
 server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
 strict-transport-security: max-age=31536000; includeSubDomains 
 vary: Api-Version 
 x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
 x-content-type-options: nosniff 
 x-frame-options: SAMEORIGIN 
 x-xss-protection: 1 

Endpoints

Operations on endpoints

Get Endpoints /org/endpoints

Gets the list of endpoints

curl -X GET "https://api-object.bluvalt.com/api/v3/org/endpoints?limit=25&includeMarker=true&order=asc" -H "accept: application/json" -H "Authorization: Bearer 4412e0df-b7c1-4634-a8a4-8de736eeac3d" -H "X-Csrf-Token: 0ebc18baf2069e1d2168d01d7052dd50"

Response body

{
  "responseTime": "2019-07-22T09:32:01.664Z",
  "status": "success",
  "apiVersion": "3.0",
  "data": []
}

Response headers

 api-version: 3 
 cache-control: private, no-cache, max-age=0 
 connection: Keep-Alive 
 content-length: 92 
 content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
 content-type: application/json 
 date: Mon, 22 Jul 2019 09:32:01 GMT 
 expires: Mon, 22 Jul 2019 09:32:01 GMT 
 keep-alive: timeout=5, max=100 
 server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
 strict-transport-security: max-age=31536000; includeSubDomains 
 vary: Api-Version 
 x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
 x-content-type-options: nosniff 
 x-frame-options: SAMEORIGIN 
 x-xss-protection: 1 
Create an Endpoint /org/endpoints

Creates a new endpoint

curl -X POST "https://api-object.bluvalt.com/api/v3/org/endpoints" -H "accept: application/json" -H "Authorization: Bearer 4412e0df-b7c1-4634-a8a4-8de736eeac3d" -H "Content-Type: application/json" -H "X-Csrf-Token: 0ebc18baf2069e1d2168d01d7052dd50" -d "{ \"displayName\": \"My endpoint\", \"endpointURI\": \"https://s3-aws-region.amazonaws.com\", \"endpointURN\": \"arn:aws:s3:::my-bucket\", \"caCert\": \"-----BEGIN CERTIFICATE----- abcdefghijkl123456780ABCDEFGHIJKL 123456/7890ABCDEFabcdefghijklABCD -----END CERTIFICATE-----\\", \"insecureTLS\": false, \"credentials\": { \"accessKeyId\": \"ABCDEFabcd1234567890\", \"secretAccessKey\": \"abcABC+123456789012345678901234567890123\" }, \"error\": { \"text\": \"Endpoint could not be contacted: connection refused\", \"time\": \"2019-07-22T09:29:00.124Z\", \"key\": \"authorization_error\" }}"

Response body

{
  "responseTime": "2019-07-22T09:34:14.894Z",
  "status": "success",
  "apiVersion": "3.0",
  "deprecated": false,
  "data": {
    "displayName": "My endpoint",
    "endpointURI": "https://s3-aws-region.amazonaws.com",
    "endpointURN": "arn:aws:s3:::my-bucket",
    "caCert": "-----BEGIN CERTIFICATE----- abcdefghijkl123456780ABCDEFGHIJKL 123456/7890ABCDEFabcdefghijklABCD -----END CERTIFICATE-----\n",
    "insecureTLS": false,
    "credentials": {
      "accessKeyId": "ABCDEFabcd1234567890",
      "secretAccessKey": "abcABC+123456789012345678901234567890123"
    },
    "error": {
      "text": "Endpoint could not be contacted: connection refused",
      "time": "2019-07-22T09:34:14.894Z",
      "key": "authorization_error"
    },
    "id": "00000000-0000-0000-0000-000000000000"
  }
}

Response headers

api-version: 3 
cache-control: private, no-cache, max-age=0 
connection: close 
content-length: 1288 
content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
content-type: application/json 
date: Mon, 22 Jul 2019 09:33:06 GMT 
expires: Mon, 22 Jul 2019 09:33:06 GMT 
server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
strict-transport-security: max-age=31536000; includeSubDomains 
vary: Api-Version 
x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
x-content-type-options: nosniff 
x-frame-options: SAMEORIGIN 
x-xss-protection: 1 
Get Endpoint by ID /org/endpoints/{id}

Retrieves a single endpoint

curl -X GET "https://api-object.bluvalt.com/api/v3/org/endpoints/00000000-0000-0000-0000-000000000000" -H "accept: application/json" -H "Authorization: Bearer 4412e0df-b7c1-4634-a8a4-8de736eeac3d" -H "X-Csrf-Token: 0ebc18baf2069e1d2168d01d7052dd50"

Response body

{
  "responseTime": "2019-07-22T09:37:31.122Z",
  "status": "success",
  "apiVersion": "3.0",
  "deprecated": false,
  "data": {
    "displayName": "My endpoint",
    "endpointURI": "https://s3-aws-region.amazonaws.com",
    "endpointURN": "arn:aws:s3:::my-bucket",
    "caCert": "-----BEGIN CERTIFICATE----- abcdefghijkl123456780ABCDEFGHIJKL 123456/7890ABCDEFabcdefghijklABCD -----END CERTIFICATE-----\n",
    "insecureTLS": false,
    "credentials": {
      "accessKeyId": "ABCDEFabcd1234567890",
      "secretAccessKey": "abcABC+123456789012345678901234567890123"
    },
    "error": {
      "text": "Endpoint could not be contacted: connection refused",
      "time": "2019-07-22T09:37:31.122Z",
      "key": "authorization_error"
    },
    "id": "00000000-0000-0000-0000-000000000000"
  }
}

Response headers

api-version: 3 
cache-control: private, no-cache, max-age=0 
connection: Keep-Alive 
content-length: 349 
content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
content-type: application/json 
date: Mon, 22 Jul 2019 09:36:16 GMT 
expires: Mon, 22 Jul 2019 09:36:16 GMT 
keep-alive: timeout=5, max=100 
server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
strict-transport-security: max-age=31536000; includeSubDomains 
vary: Api-Version 
x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
x-content-type-options: nosniff 
x-frame-options: SAMEORIGIN 
x-xss-protection: 1 
Delete a Single Endpoint /org/endpoints/{id}

Deletes a single endpoint

curl -X DELETE "https://api-object.bluvalt.com/api/v3/org/endpoints/00000000-0000-0000-0000-000000000000" -H "accept: application/json" -H "Authorization: Bearer 4412e0df-b7c1-4634-a8a4-8de736eeac3d" -H "X-Csrf-Token: 0ebc18baf2069e1d2168d01d7052dd50"

Response body

Unknown response type 204
Replace a Single Endpoint /org/endpoints/{id}

Replaces a single endpoint

curl -X PUT "https://api-object.bluvalt.com/api/v3/org/endpoints/00000000-0000-0000-0000-000000000000" -H "accept: application/json" -H "Authorization: Bearer 4412e0df-b7c1-4634-a8a4-8de736eeac3d" -H "Content-Type: application/json" -H "X-Csrf-Token: 0ebc18baf2069e1d2168d01d7052dd50" -d "{ \"displayName\": \"My endpoint\", \"endpointURI\": \"https://s3-aws-region.amazonaws.com\", \"endpointURN\": \"arn:aws:s3:::my-bucket\", \"caCert\": \"-----BEGIN CERTIFICATE----- abcdefghijkl123456780ABCDEFGHIJKL 123456/7890ABCDEFabcdefghijklABCD -----END CERTIFICATE-----\\", \"insecureTLS\": false, \"credentials\": { \"accessKeyId\": \"ABCDEFabcd1234567890\", \"secretAccessKey\": \"abcABC+123456789012345678901234567890123\" }, \"error\": { \"text\": \"Endpoint could not be contacted: connection refused\", \"time\": \"2019-07-22T09:41:09.388Z\", \"key\": \"authorization_error\" }, \"id\": \"00000000-0000-0000-0000-000000000001\"}"

Response body

{
  "responseTime": "2019-07-22T09:42:41.574Z",
  "status": "success",
  "apiVersion": "3.0",
  "deprecated": false,
  "data": {
    "displayName": "My endpoint",
    "endpointURI": "https://s3-aws-region.amazonaws.com",
    "endpointURN": "arn:aws:s3:::my-bucket",
    "caCert": "-----BEGIN CERTIFICATE----- abcdefghijkl123456780ABCDEFGHIJKL 123456/7890ABCDEFabcdefghijklABCD -----END CERTIFICATE-----\n",
    "insecureTLS": false,
    "credentials": {
      "accessKeyId": "ABCDEFabcd1234567890",
      "secretAccessKey": "abcABC+123456789012345678901234567890123"
    },
    "error": {
      "text": "Endpoint could not be contacted: connection refused",
      "time": "2019-07-22T09:42:41.574Z",
      "key": "authorization_error"
    },
    "id": "00000000-0000-0000-0000-000000000001"
  }
}

Response headers

api-version: 3 
cache-control: private, no-cache, max-age=0 
connection: Keep-Alive 
content-length: 349 
content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
content-type: application/json 
date: Mon, 22 Jul 2019 09:41:47 GMT 
expires: Mon, 22 Jul 2019 09:41:47 GMT 
keep-alive: timeout=5, max=100 
server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
strict-transport-security: max-age=31536000; includeSubDomains 
vary: Api-Version 
x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
x-content-type-options: nosniff 
x-frame-options: SAMEORIGIN 
x-xss-protection: 1 

Regions

Operations on regions

Get Regions GET /org/regions

Lists configured regions

curl -X GET "https://api-object.bluvalt.com/api/v3/org/regions" -H "accept: application/json" -H "Authorization: Bearer 7ec5b12a-8abd-4243-8b90-5a258fee0f18"

Response body

{
  "responseTime": "2019-07-17T13:25:54.365Z",
  "status": "success",
  "apiVersion": "3.0",
  "data": [
    "us-east-1"
  ]
}

Response headers

api-version: 3 
cache-control: private, no-cache, max-age=0 
connection: Keep-Alive 
content-length: 103 
content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
content-type: application/json 
date: Wed, 17 Jul 2019 13:25:54 GMT 
expires: Wed, 17 Jul 2019 13:25:54 GMT 
keep-alive: timeout=5, max=98 
server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
strict-transport-security: max-age=31536000; includeSubDomains 
vary: Api-Version 
x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
x-content-type-options: nosniff 
x-frame-options: SAMEORIGIN 
x-xss-protection: 1 

S3

Operations on S3 Access Keys

List Access Keys GET /org/users/current-user/s3-access-keys

Lists S3 Access Keys for the current User

curl -X GET "https://api-object.bluvalt.com/api/v3/org/users/current-user/s3-access-keys" -H "accept: application/json" -H "Authorization: Bearer 4be647c5-def8-40b6-8566-16b919c46e16"

Response body

{
  "responseTime": "2019-07-18T08:41:07.149Z",
  "status": "success",
  "apiVersion": "3.0",
  "data": []
}

Response headers

 api-version: 3 
 cache-control: private, no-cache, max-age=0 
 connection: Keep-Alive 
 content-length: 92 
 content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
 content-type: application/json 
 date: Thu, 18 Jul 2019 08:41:07 GMT 
 expires: Thu, 18 Jul 2019 08:41:07 GMT 
 keep-alive: timeout=5, max=100 
 server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
 strict-transport-security: max-age=31536000; includeSubDomains 
 vary: Api-Version 
 x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
 x-content-type-options: nosniff 
 x-frame-options: SAMEORIGIN 
 x-xss-protection: 1 
Create Access Key POST /org/users/current-user/s3-access-keys

Creates a new S3 Access Key for the current User

curl -X POST "https://api-object.bluvalt.com/api/v3/org/users/current-user/s3-access-keys" -H "accept: application/json" -H "Authorization: Bearer 4be647c5-def8-40b6-8566-16b919c46e16" -H "Content-Type: application/json" -d "{ \"expires\": \"2020-09-04T00:00:00.000Z\"}"

Response body

{
  "code": 201,
  "responseTime": "2019-07-18T08:45:02.837Z",
  "status": "success",
  "apiVersion": "3.0",
  "data": {
    "id": "SGKHlT-OZSZ-w9J3zIR-jZqG46UaLMz3_nWSJ42U-w==",
    "accessKey": "7K0ADCGCD4IRMVU9FE8F",
    "secretAccessKey": "MDirurS/2TNNdFmx0ZRcDPt5DxjIeFsrG5Q8RDvo",
    "displayName": "****************FE8F",
    "accountId": "45560305624791037332",
    "userURN": "urn:sgws:identity::45560305624791037332:user/test",
    "userUUID": "2ed26afd-e109-4733-9e66-da99771012a2",
    "expires": "2020-09-04T00:00:00.000Z"
  }
}

Response headers

 api-version: 3 
 cache-control: private, no-cache, max-age=0 
 connection: Keep-Alive 
 content-length: 471 
 content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
 content-type: application/json 
 date: Thu, 18 Jul 2019 08:45:02 GMT 
 expires: Thu, 18 Jul 2019 08:45:02 GMT 
 keep-alive: timeout=5, max=100 
 server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
 strict-transport-security: max-age=31536000; includeSubDomains 
 vary: Api-Version 
 x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
 x-content-type-options: nosniff 
 x-frame-options: SAMEORIGIN 
 x-xss-protection: 1 
Retrieve Access Key for a User GET /org/users/current-user/s3-access-keys/{accessKey}

Retrieves a single S3 Access Key for the current User

curl -X GET "https://api-object.bluvalt.com/api/v3/org/users/current-user/s3-access-keys/7K0ADCGCD4IRMVU9FE8F" -H "accept: application/json" -H "Authorization: Bearer 4be647c5-def8-40b6-8566-16b919c46e16"

Response body

{
  "responseTime": "2019-07-18T08:48:15.338Z",
  "status": "success",
  "apiVersion": "3.0",
  "data": {
    "id": "SGKHlT-OZSZ-w9J3zIR-jZqG46UaLMz3_nWSJ42U-w==",
    "displayName": "****************FE8F",
    "accountId": "45560305624791037332",
    "userURN": "urn:sgws:identity::45560305624791037332:user/test",
    "userUUID": "2ed26afd-e109-4733-9e66-da99771012a2",
    "expires": "2020-09-04T00:00:00.000Z"
  }
}

Response headers

 api-version: 3 
 cache-control: private, no-cache, max-age=0 
 connection: Keep-Alive 
 content-length: 364 
 content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
 content-type: application/json 
 date: Thu, 18 Jul 2019 08:48:15 GMT 
 expires: Thu, 18 Jul 2019 08:48:15 GMT 
 keep-alive: timeout=5, max=100 
 server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
 strict-transport-security: max-age=31536000; includeSubDomains 
 vary: Api-Version 
 x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
 x-content-type-options: nosniff 
 x-frame-options: SAMEORIGIN 
 x-xss-protection: 1 
Delete Access Key DELETE /org/users/current-user/s3-access-keys/{accessKey}

Deletes a single S3 Access Key for the current User

curl -X DELETE "https://api-object.bluvalt.com/api/v3/org/users/current-user/s3-access-keys/R6WPXXGV4BGOWTLEC8XT" -H "accept: application/json" -H "Authorization: Bearer 4be647c5-def8-40b6-8566-16b919c46e16"

Response body

Unknown response type 204

Response headers

api-version: 3 
cache-control: private, no-cache, max-age=0 
connection: Keep-Alive 
content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
date: Thu, 18 Jul 2019 09:31:45 GMT 
expires: Thu, 18 Jul 2019 09:31:45 GMT 
keep-alive: timeout=5, max=100 
server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
strict-transport-security: max-age=31536000; includeSubDomains 
vary: Api-Version 
x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
x-content-type-options: nosniff 
x-frame-options: SAMEORIGIN 
x-xss-protection: 1 

Users

Operations on users

Get User Information /org/users/federated-user/{shortName}

Retrieves a Tenant User by unique name

curl -X GET "https://api-object.bluvalt.com/api/v3/org/users/federated-user/Test" -H "accept: application/json" -H "Authorization: Bearer 4412e0df-b7c1-4634-a8a4-8de736eeac3d" -H "X-Csrf-Token: 0ebc18baf2069e1d2168d01d7052dd50"

Response body

{
  "responseTime": "2019-07-22T09:45:39.032Z",
  "status": "success",
  "apiVersion": "3.0",
  "deprecated": false,
  "data": {
    "fullName": "Test User",
    "memberOf": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "disable": false,
    "uniqueName": "user/Test",
    "accountId": "0",
    "id": "00000000-0000-0000-0000-000000000000",
    "federated": true,
    "userURN": "urn:sgws:identity::0:user/Test"
  }
}

Response headers

 api-version: 3 
 cache-control: private, no-cache, max-age=0 
 connection: Keep-Alive 
 content-length: 307 
 content-security-policy: frame-ancestors 'self'; block-all-mixed-content 
 content-type: application/json 
 date: Mon, 22 Jul 2019 09:45:40 GMT 
 expires: Mon, 22 Jul 2019 09:45:40 GMT 
 keep-alive: timeout=5, max=100 
 server: WEBrick/1.3.1 (Ruby/2.3.3/2016-11-21) 
 strict-transport-security: max-age=31536000; includeSubDomains 
 vary: Api-Version 
 x-content-security-policy: frame-ancestors: 'self'; block-all-mixed-content 
 x-content-type-options: nosniff 
 x-frame-options: SAMEORIGIN 
 x-xss-protection: 1