Users
Responses
200
Users were retrieved successfully
application/json
400
Input Error
application/json
422
Validation Error
application/json
500
Internal Server Error
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": "[email protected]",
"id": "text",
"mobile": "text",
"org_id": "text",
"org_name": "text"
}
]
}
]
Create new user
Body
aclinteger · max: 20Required
contact_namestringRequired
emailstring · emailRequired
mobilestringRequired
org_idstringRequired
Responses
200
New user was created successfully
application/json
400
Input Error
application/json
422
Validation Error
application/json
500
Internal Server Error
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": "[email protected]",
"mobile": "text",
"org_id": "text"
}
{
"id": "text"
}
Path parameters
entry_idstringRequired
Account ID
Responses
200
User details were retrieved successfully
application/json
400
Input Error
application/json
422
Validation Error
application/json
500
Internal Server Error
application/json
get
GET /api/v4.0/accounts/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"acl": 1,
"contact_name": "text",
"email": "[email protected]",
"id": "text",
"mobile": "text",
"org_id": "text",
"org_name": "text",
"otpseed": "text"
}
Update details of a user
Path parameters
entry_idstringRequired
Account ID
Body
aclinteger · max: 20Required
contact_namestringRequired
mobilestringRequired
Responses
200
User updated successfully
application/json
Responseany
400
Input Error
application/json
422
Validation Error
application/json
500
Internal Server Error
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
Delete user by user id
Path parameters
entry_idstringRequired
Account ID
Responses
200
User was deleted successfully
application/json
Responseany
400
Input Error
application/json
422
Validation Error
application/json
500
Internal Server Error
application/json
delete
DELETE /api/v4.0/accounts/{entry_id} HTTP/1.1
Host:
Accept: */*
No content
Responses
200
API keys received successfully
application/json
400
Input Error
application/json
422
Validation Error
application/json
500
Internal Server Error
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"
}
]
}
Revokes API key and makes it unavailable for use
Path parameters
entry_idstringRequired
API key ID
Responses
200
API key was revoked successfully
application/json
Responseany
400
Input Error
application/json
422
Validation Error
application/json
500
Internal Server Error
application/json
put
PUT /api/v4.0/accounts/api-keys/{entry_id} HTTP/1.1
Host:
Accept: */*
No content
Path parameters
entry_idstringRequired
Account ID
Responses
200
API keys for specified user were retrieved successfully
application/json
400
Input Error
application/json
422
Validation Error
application/json
500
Internal Server Error
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"
}
]
}
Path parameters
entry_idstringRequired
Account ID
Body
titlestring · min: 1Required
Responses
200
API key for specified user was generated successfully
application/json
Responseany
400
Input Error
application/json
422
Validation Error
application/json
500
Internal Server Error
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
Responses
200
SSO config retrieved successfully
application/json
400
Bad Request
application/json
422
Validation Error
application/json
500
Internal Server Error
application/json
get
GET /api/v4.0/accounts/sso HTTP/1.1
Host:
Accept: */*
{
"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": 1
},
"protocol": "oauth2",
"provider": "okta",
"title": "text"
}
Body
enabledbooleanOptionalDefault:
Is that profile enabled or not.
false
paramsall ofRequired
SSO provider OAuth2 protocol parameters
protocolall ofRequired
SSO protocol
string · enumOptionalPossible values:
An enumeration.
providerall ofRequired
SSO provider
string · enumOptionalPossible values:
An enumeration.
titlestringRequired
Title of the SSO profile that will be displayed on the login page.
Responses
201
SSO config was updated successfully
application/json
400
Bad Request
application/json
422
Validation Error
application/json
500
Internal Server Error
application/json
post
POST /api/v4.0/accounts/sso/oauth2 HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 269
{
"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": 1
},
"protocol": "oauth2",
"provider": "okta",
"title": "text"
}
{
"cert_thumbprint": "text",
"code": 1,
"message": "text"
}
Body
enabledbooleanOptionalDefault:
Is that profile enabled or not.
false
paramsall ofRequired
SSO provider SAML2 protocol parameters
protocolall ofRequired
SSO protocol
string · enumOptionalPossible values:
An enumeration.
providerall ofRequired
SSO provider
string · enumOptionalPossible values:
An enumeration.
titlestringRequired
Title of the SSO profile that will be displayed on the login page.
Responses
201
SSO config was updated successfully
application/json
400
Bad Request
application/json
422
Validation Error
application/json
500
Internal Server Error
application/json
post
POST /api/v4.0/accounts/sso/saml2 HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 299
{
"enabled": false,
"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"
}
Last updated
Was this helpful?