Users | Reblaze Product Manual

Get list of users

GET/api/v4.0/accounts/users

Response

Users were retrieved successfully

Body

id*Id

name*Name

users*Users

Request

const response = await fetch('/api/v4.0/accounts/users', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "name": "text",
    "users": [
      {
        "acl": 0,
        "contact_name": "text",
        "email": "name@gmail.com",
        "id": "text",
        "mobile": "text",
        "org_id": "text",
        "org_name": "text"
      }
    ]
  }
]

Create new user

POST/api/v4.0/accounts/users

Body

acl*Acl

contact_name*Contact Name

email*Email

mobile*Mobile

org_id*Org Id

Response

New user was created successfully

Body

id*Id

Request

const response = await fetch('/api/v4.0/accounts/users', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "acl": 0,
      "mobile": "text",
      "contact_name": "text",
      "email": "name@gmail.com",
      "org_id": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text"
}

Get user details

GET/api/v4.0/accounts/{entry_id}

Path parameters

entry_id*Account ID

Account ID

Response

User details were retrieved successfully

Body

acl*Acl

contact_name*Contact Name

email*Email

id*Id

mobile*Mobile

org_id*Org Id

org_name*Org Name

otpseed*Otpseed

Request

const response = await fetch('/api/v4.0/accounts/{entry_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "acl": 0,
  "contact_name": "text",
  "email": "name@gmail.com",
  "id": "text",
  "mobile": "text",
  "org_id": "text",
  "org_name": "text",
  "otpseed": "text"
}

Modify user

Update details of a user

PUT/api/v4.0/accounts/{entry_id}

Path parameters

entry_id*Account ID

Account ID

Body

acl*Acl

contact_name*Contact Name

mobile*Mobile

Response

User updated successfully

Body

any

Request

const response = await fetch('/api/v4.0/accounts/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "acl": 0,
      "mobile": "text",
      "contact_name": "text"
    }),
});
const data = await response.json();

Response

{
  "code": 0,
  "message": "text"
}

Delete user

Delete user by user id

DELETE/api/v4.0/accounts/{entry_id}

Path parameters

entry_id*Account ID

Account ID

Response

User was deleted successfully

Body

any

Request

const response = await fetch('/api/v4.0/accounts/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "code": 0,
  "message": "text"
}

Get all API keys associated with the planet

GET/api/v4.0/accounts/api-keys

Response

API keys received successfully

Body

totalinteger

Example: 1

itemsarray of ApiKey

Request

const response = await fetch('/api/v4.0/accounts/api-keys', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "total": 1,
  "items": [
    {
      "account_id": "text",
      "created_by": "text",
      "created_time": 0,
      "email": "text",
      "id": "text",
      "key": "text",
      "title": "text"
    }
  ]
}

Delete an API key

Revokes API key and makes it unavailable for use

PUT/api/v4.0/accounts/api-keys/{entry_id}

Path parameters

entry_id*Key Id

API key ID

Response

API key was revoked successfully

Body

any

Request

const response = await fetch('/api/v4.0/accounts/api-keys/{entry_id}', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

{
  "code": 0,
  "message": "text"
}

Get API keys for a user

GET/api/v4.0/accounts/{entry_id}/api-keys

Path parameters

entry_id*Account ID

Account ID

Response

API keys for specified user were retrieved successfully

Body

totalinteger

Example: 1

itemsarray of ApiKey

Request

const response = await fetch('/api/v4.0/accounts/{entry_id}/api-keys', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "total": 1,
  "items": [
    {
      "account_id": "text",
      "created_by": "text",
      "created_time": 0,
      "email": "text",
      "id": "text",
      "key": "text",
      "title": "text"
    }
  ]
}

Generate an API key for a user

POST/api/v4.0/accounts/{entry_id}/api-keys

Path parameters

entry_id*Account ID

Account ID

Body

title*Title

Response

API key for specified user was generated successfully

Body

any

Request

const response = await fetch('/api/v4.0/accounts/{entry_id}/api-keys', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "text"
    }),
});
const data = await response.json();

Response

{
  "code": 0,
  "message": "text"
}

Get SSO Config for the planet

GET/api/v4.0/accounts/sso

Response

SSO config retrieved successfully

Body

enabledEnabled

Is that profile enabled or not.

params*Params

SSO provider parameters

protocol*all of

SSO protocol

provider*all of

SSO provider

title*Title

Title of the SSO profile that will be displayed on the login page.

Request

const response = await fetch('/api/v4.0/accounts/sso', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "enabled": false,
  "params": {
    "client_id": "text",
    "client_secret": "text",
    "issuer": "text",
    "roles": [
      {
        "idp_group": "text",
        "reblaze_groups": [
          "reblaze-events-viewer"
        ]
      }
    ],
    "roles_claim_key": "text",
    "token_expiration_threshold": 0
  },
  "protocol": {},
  "provider": {},
  "title": "text"
}

Add/Update SSO Config of OAuth2 protocol for the planet

POST/api/v4.0/accounts/sso/oauth2

Body

enabledEnabled

Is that profile enabled or not.

params*Params

SSO provider OAuth2 protocol parameters

protocol*all of

SSO protocol

provider*all of

SSO provider

title*Title

Title of the SSO profile that will be displayed on the login page.

Response

SSO config was updated successfully

Body

cert_thumbprintCert Thumbprint

Certificate thumbprint to show user certificate if correct. Is used only for user output.

code*Code

message*Message

Request

const response = await fetch('/api/v4.0/accounts/sso/oauth2', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "text",
      "provider": {},
      "protocol": {},
      "params": {
        "client_id": "text",
        "client_secret": "text",
        "issuer": "text"
      }
    }),
});
const data = await response.json();

Response

{
  "cert_thumbprint": "text",
  "code": 0,
  "message": "text"
}

Add/Update SSO Config of SAML2 protocol for the planet

POST/api/v4.0/accounts/sso/saml2

Body

enabledEnabled

Is that profile enabled or not.

params*Params

SSO provider SAML2 protocol parameters

protocol*all of

SSO protocol

provider*all of

SSO provider

title*Title

Title of the SSO profile that will be displayed on the login page.

Response

SSO config was updated successfully

Body

cert_thumbprintCert Thumbprint

Certificate thumbprint to show user certificate if correct. Is used only for user output.

code*Code

message*Message

Request

const response = await fetch('/api/v4.0/accounts/sso/saml2', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "text",
      "provider": {},
      "protocol": {},
      "params": {
        "tenantId": "text",
        "entityId": "text",
        "login_url": "https://example.com"
      }
    }),
});
const data = await response.json();

Response

{
  "cert_thumbprint": "text",
  "code": 0,
  "message": "text"
}