Skip to content

TenantuserApi.md

Latest commit

 

History

History
653 lines (382 loc) · 18.1 KB

TenantuserApi.md

File metadata and controls

653 lines (382 loc) · 18.1 KB

TenantuserApi

All URIs are relative to **

Method HTTP request Description
tenantuserCreateAPIKey POST /api/v3/apikeys Summary: Create API key
Description: Create API Key.
tenantuserDeleteAPIKey DELETE /api/v3/apikeys/{id} Summary: Delete API key
Description: Delete APIKey Document based on the document id.
tenantuserDeleteRole DELETE /api/v3/roles/{role_id} Summary: Delete role
Description: Delete a role.
tenantuserGetAPIKeys GET /api/v3/apikeys Summary: Get API keys
Description: Get all APIKeys base on a tenant ID.
tenantuserGetCurrentUser GET /api/v3/currentuser Summary: Get current user
Description: Return the currently authenticated user.
tenantuserGetPrivilege GET /api/v3/privileges/{privilege.privilege_id} Summary: Get privilege
Description: Return privilege.
tenantuserGetPrivileges GET /api/v3/privileges Summary: Get privileges
Description: Return all available privileges (pages, restapi, reports, etc) if no roles are specified
If roles are specified, returns cumulative privileges for the list of roles.
tenantuserGetRole GET /api/v3/roles/{role_id} Summary: Get role
Description: Return single role.
tenantuserGetRoles GET /api/v3/roles Summary: Get roles
Description: Return all roles without privileges.
tenantuserGetUser GET /api/v3/users/user/{user_id} Summary: Get user
Description: Return full user for specified user_id.
tenantuserGetUserNames POST /api/v3/users/names Summary: Get user names
Description: Get user names.
tenantuserGetUserTenant GET /api/v3/users/tenant/{user_id} Summary: Get user tenant
Description: Return the user plus tenant information.
tenantuserPostPrivilegesBulk POST /api/v3/privileges Summary: Post privileges bulk
Description: Perform bulk user add preivilege.
tenantuserPostRole POST /api/v3/roles Summary: Post role
Description: Create a new role.
tenantuserUpdatePrivilege PATCH /api/v3/privileges/{privilege_id} Summary: Update privilege
Description: Update privilege.
tenantuserUpdatePrivilegesRoleBulk PATCH /api/v3/privileges Summary: Update privileges role bulk
Description: Perform bulk user update role.
tenantuserUpdateRole PATCH /api/v3/roles/{role_id} Summary: Update role
Description: Update single role.
tenantuserUpdateUserRoleBulk PATCH /api/v3/users/role Summary: Update user role bulk
Description: Perform bulk user add or remove role.

tenantuserCreateAPIKey

Summary: Create API key Description: Create API Key.

Example

 tenantuserCreateAPIKey

Parameters

Name Type Description Notes
tenantuserv3CreateApiKeyRequest Tenantuserv3CreateApiKeyRequest

Return type

Tenantuserv3CreateApiKeyResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenantuserDeleteAPIKey

Summary: Delete API key Description: Delete APIKey Document based on the document id.

Example

 tenantuserDeleteAPIKey id=value

Parameters

Name Type Description Notes
id string Apikey id. [default to null]

Return type

map

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenantuserDeleteRole

Summary: Delete role Description: Delete a role.

Example

 tenantuserDeleteRole role_id=value

Parameters

Name Type Description Notes
roleId string ID or role deleted. [default to null]

Return type

map

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenantuserGetAPIKeys

Summary: Get API keys Description: Get all APIKeys base on a tenant ID.

Example

 tenantuserGetAPIKeys

Parameters

This endpoint does not need any parameter.

Return type

Tenantuserv3GetApiKeysResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenantuserGetCurrentUser

Summary: Get current user Description: Return the currently authenticated user.

Example

 tenantuserGetCurrentUser

Parameters

This endpoint does not need any parameter.

Return type

Tenantuserv3GetCurrentUserResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenantuserGetPrivilege

Summary: Get privilege Description: Return privilege.

Example

 tenantuserGetPrivilege privilege.privilege_id=value  privilege.type=value

Parameters

Name Type Description Notes
privilegePeriodprivilegeId string Privilege ID. [default to null]
privilegePeriodtype string Privilege Type - a report, group, and datasource may have the same ID. By passing type, the artifact can be uniquely determined. [optional] [default to null]

Return type

Tenantuserv3GetPrivilegeResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenantuserGetPrivileges

Summary: Get privileges Description: Return all available privileges (pages, restapi, reports, etc) if no roles are specified If roles are specified, returns cumulative privileges for the list of roles.

Example

 tenantuserGetPrivileges  Specify as:  roles=value1 roles=value2 roles=...  type=value

Parameters

Name Type Description Notes
roles array[string] If empty, will return all privileges. [optional] [default to null]
type string Type of privilege to return: group, page, permission, report, restapi, etc. [optional] [default to null]

Return type

Tenantuserv3GetPrivilegesResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenantuserGetRole

Summary: Get role Description: Return single role.

Example

 tenantuserGetRole role_id=value

Parameters

Name Type Description Notes
roleId string ID of role to be returned. [default to null]

Return type

Tenantuserv3Role

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenantuserGetRoles

Summary: Get roles Description: Return all roles without privileges.

Example

 tenantuserGetRoles

Parameters

This endpoint does not need any parameter.

Return type

Tenantuserv3GetRolesResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenantuserGetUser

Summary: Get user Description: Return full user for specified user_id.

Example

 tenantuserGetUser user_id=value

Parameters

Name Type Description Notes
userId string User id defaults to the current user or specify "current" or an actual user id. [default to null]

Return type

Tenantuserv3GetUserResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenantuserGetUserNames

Summary: Get user names Description: Get user names.

Example

 tenantuserGetUserNames

Parameters

Name Type Description Notes
tenantuserv3GetUserNamesRequest Tenantuserv3GetUserNamesRequest

Return type

Tenantuserv3GetUserNamesResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenantuserGetUserTenant

Summary: Get user tenant Description: Return the user plus tenant information.

Example

 tenantuserGetUserTenant user_id=value

Parameters

Name Type Description Notes
userId string User id defaults to the current user or specify "current" or an actual user id. [default to null]

Return type

Tenantuserv3GetUserTenantResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenantuserPostPrivilegesBulk

Summary: Post privileges bulk Description: Perform bulk user add preivilege.

Example

 tenantuserPostPrivilegesBulk

Parameters

Name Type Description Notes
tenantuserv3PostPrivilegesBulkRequest Tenantuserv3PostPrivilegesBulkRequest

Return type

Tenantuserv3PostPrivilegesBulkResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenantuserPostRole

Summary: Post role Description: Create a new role.

Example

 tenantuserPostRole

Parameters

Name Type Description Notes
tenantuserv3PostRoleRequest Tenantuserv3PostRoleRequest

Return type

Tenantuserv3PostRoleResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenantuserUpdatePrivilege

Summary: Update privilege Description: Update privilege.

Example

 tenantuserUpdatePrivilege privilege_id=value

Parameters

Name Type Description Notes
privilegeId string Permanent id of the privilege to be updated or created. [default to null]
tenantuserv3UpdatePrivilegeRequest Tenantuserv3UpdatePrivilegeRequest

Return type

Tenantuserv3UpdatePrivilegeResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenantuserUpdatePrivilegesRoleBulk

Summary: Update privileges role bulk Description: Perform bulk user update role.

Example

 tenantuserUpdatePrivilegesRoleBulk

Parameters

Name Type Description Notes
tenantuserv3UpdatePrivilegesBulkRequest Tenantuserv3UpdatePrivilegesBulkRequest

Return type

Tenantuserv3UpdatePrivilegesBulkResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenantuserUpdateRole

Summary: Update role Description: Update single role.

Example

 tenantuserUpdateRole role_id=value

Parameters

Name Type Description Notes
roleId string Permanent id of the role. [default to null]
tenantuserv3UpdateRoleRequest Tenantuserv3UpdateRoleRequest

Return type

Tenantuserv3UpdateRoleResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tenantuserUpdateUserRoleBulk

Summary: Update user role bulk Description: Perform bulk user add or remove role.

Example

 tenantuserUpdateUserRoleBulk

Parameters

Name Type Description Notes
tenantuserv3UpdateUserRoleBulkRequest Tenantuserv3UpdateUserRoleBulkRequest

Return type

Tenantuserv3UpdateUserRoleBulkResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]