Users | Reblaze Part of Link11

Reblaze Part of Link11

Get user details

get

Path parameters

entry_idstringrequired

Account ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/accounts/{entry_id}'

200

400

422

500

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

User details were retrieved successfully

Delete user

delete

Delete user by user id

Path parameters

entry_idstringrequired

Account ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/v4.0/accounts/{entry_id}'

200

400

422

500

No body

User was deleted successfully

Get all API keys associated with the planet

get

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/accounts/api-keys'

200

400

422

500

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

API keys received successfully

Delete an API key

put

Revokes API key and makes it unavailable for use

Path parameters

entry_idstringrequired

API key ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v4.0/accounts/api-keys/{entry_id}'

200

400

422

500

No body

API key was revoked successfully

Get API keys for a user

get

Path parameters

entry_idstringrequired

Account ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/accounts/{entry_id}/api-keys'

200

400

422

500

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

API keys for specified user were retrieved successfully

Get SSO Config for the planet

get

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/accounts/sso'

200

400

422

500

{
  "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"
}

SSO config retrieved successfully

Get list of users

get

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/accounts/users'

200

400

422

500

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

Users were retrieved successfully

Create new user

post

Create new user

Body

aclinteger · max: 20required

contact_namestringrequired

emailstring · emailrequired

mobilestringrequired

org_idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v4.0/accounts/users' \
  --header 'Content-Type: application/json' \
  --data '{
    "acl": 1,
    "contact_name": "text",
    "email": "name@gmail.com",
    "mobile": "text",
    "org_id": "text"
  }'

200

400

422

500

{
  "id": "text"
}

New user was created successfully

Modify user

put

Update details of a user

Path parameters

entry_idstringrequired

Account ID

Body

aclinteger · max: 20required

contact_namestringrequired

mobilestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v4.0/accounts/{entry_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "acl": 1,
    "contact_name": "text",
    "mobile": "text"
  }'

200

400

422

500

No body

User updated successfully

Generate an API key for a user

post

Path parameters

entry_idstringrequired

Account ID

Body

titlestring · min: 1required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v4.0/accounts/{entry_id}/api-keys' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "text"
  }'

200

400

422

500

No body

API key for specified user was generated successfully

Add/Update SSO Config of OAuth2 protocol for the planet

post

Body

enabledboolean · default: falseoptional

Is that profile enabled or not.

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

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v4.0/accounts/sso/oauth2' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
  }'

201

400

422

500

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

SSO config was updated successfully

Add/Update SSO Config of SAML2 protocol for the planet

post

Body

enabledboolean · default: falseoptional

Is that profile enabled or not.

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

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v4.0/accounts/sso/saml2' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
  }'

201

400

422

500

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

SSO config was updated successfully

Get user details

Delete user

Get all API keys associated with the planet

Delete an API key

Get API keys for a user

Get SSO Config for the planet

Get list of users

Create new user

Modify user

Generate an API key for a user

Add/Update SSO Config of OAuth2 protocol for the planet

Show SSOOAuthConfigParams

Show ProtocolEnum

Show ProviderEnum

Add/Update SSO Config of SAML2 protocol for the planet

Show SSOSAML2ConfigParams

Show ProtocolEnum

Show ProviderEnum