Users

Get list of users

get
Responses
chevron-right
200

Users were retrieved successfully

application/json
get
/api/v4.3/accounts/users

Create new user

post

Create new user

Body
aclinteger · max: 20Required
contact_namestringRequired
emailstring · emailRequired
mobilestringRequired
org_idstringRequired
Responses
chevron-right
200

New user was created successfully

application/json
post
/api/v4.3/accounts/users

Get user details

get
Path parameters
entry_idstringRequired

Account ID

Responses
chevron-right
200

User details were retrieved successfully

application/json
get
/api/v4.3/accounts/{entry_id}

Modify user

put

Update details of a user

Path parameters
entry_idstringRequired

Account ID

Body
aclinteger · max: 20Required
contact_namestringRequired
mobilestringRequired
Responses
chevron-right
200

User updated successfully

application/json
Responseany
put
/api/v4.3/accounts/{entry_id}

No content

Delete user

delete

Delete user by user id

Path parameters
entry_idstringRequired

Account ID

Responses
chevron-right
200

User was deleted successfully

application/json
Responseany
delete
/api/v4.3/accounts/{entry_id}

No content

Get all API keys associated with the planet

get
Responses
chevron-right
200

API keys received successfully

application/json
get
/api/v4.3/accounts/api-keys

Delete an API key

put

Revokes API key and makes it unavailable for use

Path parameters
entry_idstringRequired

API key ID

Responses
chevron-right
200

API key was revoked successfully

application/json
Responseany
put
/api/v4.3/accounts/api-keys/{entry_id}

No content

Get API keys for a user

get
Path parameters
entry_idstringRequired

Account ID

Responses
chevron-right
200

API keys for specified user were retrieved successfully

application/json
get
/api/v4.3/accounts/{entry_id}/api-keys

Generate an API key for a user

post
Path parameters
entry_idstringRequired

Account ID

Body
titlestring · min: 1Required
Responses
chevron-right
200

API key for specified user was generated successfully

application/json
Responseany
post
/api/v4.3/accounts/{entry_id}/api-keys

No content

Get SSO Config for the planet

get
Responses
chevron-right
200

SSO config retrieved successfully

application/json
get
/api/v4.3/accounts/sso

Add/Update SSO Config of OAuth2 protocol for the planet

post
Body
enabledbooleanOptional

Is that profile enabled or not.

Default: false
protocolall ofRequired

SSO protocol

string · enumOptionalPossible values:
providerall ofRequired

SSO provider

string · enumOptional

An enumeration.

Possible values:
titlestringRequired

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

Responses
post
/api/v4.3/accounts/sso/oauth2

Add/Update SSO Config of SAML2 protocol for the planet

post
Body
enabledbooleanOptional

Is that profile enabled or not.

Default: false
protocolall ofRequired

SSO protocol

string · enumOptionalPossible values:
providerall ofRequired

SSO provider

string · enumOptional

An enumeration.

Possible values:
titlestringRequired

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

Responses
post
/api/v4.3/accounts/sso/saml2

Last updated

Was this helpful?