Users | Reblaze Part of Link11

Reblaze Part of Link11

Get user details

get

Path parameters

entry_idstringRequired

Account ID

Responses

application/json

objectOptional

application/json

get

GET /api/v4.0/accounts/{entry_id} HTTP/1.1
Host: 
Accept: */*

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

Delete user

delete

Delete user by user id

Path parameters

entry_idstringRequired

Account ID

Responses

application/json

anyOptional

application/json

delete

DELETE /api/v4.0/accounts/{entry_id} HTTP/1.1
Host: 
Accept: */*

No content

Get all API keys associated with the planet

get

Responses

application/json

objectOptional

application/json

get

GET /api/v4.0/accounts/api-keys HTTP/1.1
Host: 
Accept: */*

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

Delete an API key

put

Revokes API key and makes it unavailable for use

Path parameters

entry_idstringRequired

API key ID

Responses

application/json

anyOptional

application/json

put

PUT /api/v4.0/accounts/api-keys/{entry_id} HTTP/1.1
Host: 
Accept: */*

No content

Get API keys for a user

get

Path parameters

entry_idstringRequired

Account ID

Responses

application/json

objectOptional

application/json

get

GET /api/v4.0/accounts/{entry_id}/api-keys HTTP/1.1
Host: 
Accept: */*

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

Get SSO Config for the planet

get

Responses

application/json

objectOptional

application/json

get

GET /api/v4.0/accounts/sso HTTP/1.1
Host: 
Accept: */*

{
  "enabled": true,
  "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": 1
  },
  "protocol": "oauth2",
  "provider": "okta",
  "title": "text"
}

Get list of users

get

Responses

application/json

object[]Optional

application/json

get

GET /api/v4.0/accounts/users HTTP/1.1
Host: 
Accept: */*

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

Create new user

post

Create new user

Body

aclinteger · max: 20Required

contact_namestringRequired

emailstring · emailRequired

mobilestringRequired

org_idstringRequired

Responses

application/json

objectOptional

application/json

post

POST /api/v4.0/accounts/users HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "acl": 1,
  "contact_name": "text",
  "email": "name@gmail.com",
  "mobile": "text",
  "org_id": "text"
}

{
  "id": "text"
}

Modify user

put

Update details of a user

Path parameters

entry_idstringRequired

Account ID

Body

aclinteger · max: 20Required

contact_namestringRequired

mobilestringRequired

Responses

application/json

anyOptional

application/json

put

PUT /api/v4.0/accounts/{entry_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "acl": 1,
  "contact_name": "text",
  "mobile": "text"
}

No content

Generate an API key for a user

post

Path parameters

entry_idstringRequired

Account ID

Body

titlestring · min: 1Required

Responses

application/json

anyOptional

application/json

post

POST /api/v4.0/accounts/{entry_id}/api-keys HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "title": "text"
}

No content

Add/Update SSO Config of OAuth2 protocol for the planet

post

Body

enabledbooleanOptional

Is that profile enabled or not.

Default: false

paramsall ofRequired

SSO provider OAuth2 protocol parameters

protocolall ofRequired

SSO protocol

An enumeration.

providerall ofRequired

SSO provider

An enumeration.

titlestringRequired

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

Responses

application/json

objectOptional

application/json

post

POST /api/v4.0/accounts/sso/oauth2 HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 268

{
  "enabled": true,
  "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": 1
  },
  "protocol": "oauth2",
  "provider": "okta",
  "title": "text"
}

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

Add/Update SSO Config of SAML2 protocol for the planet

post

Body

enabledbooleanOptional

Is that profile enabled or not.

Default: false

paramsall ofRequired

SSO provider SAML2 protocol parameters

protocolall ofRequired

SSO protocol

An enumeration.

providerall ofRequired

SSO provider

An enumeration.

titlestringRequired

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

Responses

application/json

objectOptional

application/json

post

POST /api/v4.0/accounts/sso/saml2 HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 298

{
  "enabled": true,
  "params": {
    "entityId": "text",
    "login_url": "https://example.com",
    "roles": [
      {
        "idp_group": "text",
        "reblaze_groups": [
          "reblaze-events-viewer"
        ]
      }
    ],
    "roles_claim_key": "text",
    "tenantId": "text",
    "token_expiration_threshold": 1,
    "x509cert": "text"
  },
  "protocol": "oauth2",
  "provider": "okta",
  "title": "text"
}

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