Skip to content

Latest commit

 

History

History
1042 lines (734 loc) · 33.4 KB

PermissionsApi.md

File metadata and controls

1042 lines (734 loc) · 33.4 KB

gooddata_api_client.PermissionsApi

All URIs are relative to http://localhost

Method HTTP request Description
available_assignees GET /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/availableAssignees Get Available Assignees
dashboard_permissions GET /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/permissions Get Dashboard Permissions
get_organization_permissions GET /api/v1/layout/organization/permissions Get organization permissions
get_user_group_permissions GET /api/v1/layout/userGroups/{userGroupId}/permissions Get permissions for the user-group
get_user_permissions GET /api/v1/layout/users/{userId}/permissions Get permissions for the user
get_workspace_permissions GET /api/v1/layout/workspaces/{workspaceId}/permissions Get permissions for the workspace
manage_dashboard_permissions POST /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions Manage Permissions for a Dashboard
manage_data_source_permissions POST /api/v1/actions/dataSources/{dataSourceId}/managePermissions Manage Permissions for a Data Source
manage_organization_permissions POST /api/v1/actions/organization/managePermissions Manage Permissions for a Organization
manage_workspace_permissions POST /api/v1/actions/workspaces/{workspaceId}/managePermissions Manage Permissions for a Workspace
set_organization_permissions PUT /api/v1/layout/organization/permissions Set organization permissions
set_user_group_permissions PUT /api/v1/layout/userGroups/{userGroupId}/permissions Set permissions for the user-group
set_user_permissions PUT /api/v1/layout/users/{userId}/permissions Set permissions for the user
set_workspace_permissions PUT /api/v1/layout/workspaces/{workspaceId}/permissions Set permissions for the workspace

available_assignees

AvailableAssignees available_assignees(workspace_id, dashboard_id)

Get Available Assignees

Example

import time
import gooddata_api_client
from gooddata_api_client.api import permissions_api
from gooddata_api_client.model.available_assignees import AvailableAssignees
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = permissions_api.PermissionsApi(api_client)
    workspace_id = "workspaceId_example" # str | 
    dashboard_id = "dashboardId_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Get Available Assignees
        api_response = api_instance.available_assignees(workspace_id, dashboard_id)
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling PermissionsApi->available_assignees: %s\n" % e)

Parameters

Name Type Description Notes
workspace_id str
dashboard_id str

Return type

AvailableAssignees

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

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

dashboard_permissions

DashboardPermissions dashboard_permissions(workspace_id, dashboard_id)

Get Dashboard Permissions

Example

import time
import gooddata_api_client
from gooddata_api_client.api import permissions_api
from gooddata_api_client.model.dashboard_permissions import DashboardPermissions
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = permissions_api.PermissionsApi(api_client)
    workspace_id = "workspaceId_example" # str | 
    dashboard_id = "dashboardId_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Get Dashboard Permissions
        api_response = api_instance.dashboard_permissions(workspace_id, dashboard_id)
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling PermissionsApi->dashboard_permissions: %s\n" % e)

Parameters

Name Type Description Notes
workspace_id str
dashboard_id str

Return type

DashboardPermissions

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

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

get_organization_permissions

[DeclarativeOrganizationPermission] get_organization_permissions()

Get organization permissions

Retrieve organization permissions

Example

import time
import gooddata_api_client
from gooddata_api_client.api import permissions_api
from gooddata_api_client.model.declarative_organization_permission import DeclarativeOrganizationPermission
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = permissions_api.PermissionsApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # Get organization permissions
        api_response = api_instance.get_organization_permissions()
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling PermissionsApi->get_organization_permissions: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

[DeclarativeOrganizationPermission]

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Retrieved all organization permissions. -

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

get_user_group_permissions

DeclarativeUserGroupPermissions get_user_group_permissions(user_group_id)

Get permissions for the user-group

Retrieve current set of permissions of the user-group in a declarative form.

Example

import time
import gooddata_api_client
from gooddata_api_client.api import permissions_api
from gooddata_api_client.model.declarative_user_group_permissions import DeclarativeUserGroupPermissions
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = permissions_api.PermissionsApi(api_client)
    user_group_id = "userGroupId_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Get permissions for the user-group
        api_response = api_instance.get_user_group_permissions(user_group_id)
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling PermissionsApi->get_user_group_permissions: %s\n" % e)

Parameters

Name Type Description Notes
user_group_id str

Return type

DeclarativeUserGroupPermissions

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Retrieved current set of permissions. -

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

get_user_permissions

DeclarativeUserPermissions get_user_permissions(user_id)

Get permissions for the user

Retrieve current set of permissions of the user in a declarative form.

Example

import time
import gooddata_api_client
from gooddata_api_client.api import permissions_api
from gooddata_api_client.model.declarative_user_permissions import DeclarativeUserPermissions
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = permissions_api.PermissionsApi(api_client)
    user_id = "userId_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Get permissions for the user
        api_response = api_instance.get_user_permissions(user_id)
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling PermissionsApi->get_user_permissions: %s\n" % e)

Parameters

Name Type Description Notes
user_id str

Return type

DeclarativeUserPermissions

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Retrieved current set of permissions. -

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

get_workspace_permissions

DeclarativeWorkspacePermissions get_workspace_permissions(workspace_id)

Get permissions for the workspace

Retrieve current set of permissions of the workspace in a declarative form.

Example

import time
import gooddata_api_client
from gooddata_api_client.api import permissions_api
from gooddata_api_client.model.declarative_workspace_permissions import DeclarativeWorkspacePermissions
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = permissions_api.PermissionsApi(api_client)
    workspace_id = "workspaceId_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Get permissions for the workspace
        api_response = api_instance.get_workspace_permissions(workspace_id)
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling PermissionsApi->get_workspace_permissions: %s\n" % e)

Parameters

Name Type Description Notes
workspace_id str

Return type

DeclarativeWorkspacePermissions

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Retrieved current set of permissions. -

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

manage_dashboard_permissions

manage_dashboard_permissions(workspace_id, dashboard_id, manage_dashboard_permissions_request_inner)

Manage Permissions for a Dashboard

Example

import time
import gooddata_api_client
from gooddata_api_client.api import permissions_api
from gooddata_api_client.model.manage_dashboard_permissions_request_inner import ManageDashboardPermissionsRequestInner
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = permissions_api.PermissionsApi(api_client)
    workspace_id = "workspaceId_example" # str | 
    dashboard_id = "dashboardId_example" # str | 
    manage_dashboard_permissions_request_inner = [
        ManageDashboardPermissionsRequestInner(None),
    ] # [ManageDashboardPermissionsRequestInner] | 

    # example passing only required values which don't have defaults set
    try:
        # Manage Permissions for a Dashboard
        api_instance.manage_dashboard_permissions(workspace_id, dashboard_id, manage_dashboard_permissions_request_inner)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling PermissionsApi->manage_dashboard_permissions: %s\n" % e)

Parameters

Name Type Description Notes
workspace_id str
dashboard_id str
manage_dashboard_permissions_request_inner [ManageDashboardPermissionsRequestInner]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 No Content -

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

manage_data_source_permissions

manage_data_source_permissions(data_source_id, data_source_permission_assignment)

Manage Permissions for a Data Source

Manage Permissions for a Data Source

Example

import time
import gooddata_api_client
from gooddata_api_client.api import permissions_api
from gooddata_api_client.model.data_source_permission_assignment import DataSourcePermissionAssignment
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = permissions_api.PermissionsApi(api_client)
    data_source_id = "dataSourceId_example" # str | 
    data_source_permission_assignment = [
        DataSourcePermissionAssignment(
            assignee_identifier=AssigneeIdentifier(
                id="id_example",
                type="user",
            ),
            permissions=[
                "MANAGE",
            ],
        ),
    ] # [DataSourcePermissionAssignment] | 

    # example passing only required values which don't have defaults set
    try:
        # Manage Permissions for a Data Source
        api_instance.manage_data_source_permissions(data_source_id, data_source_permission_assignment)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling PermissionsApi->manage_data_source_permissions: %s\n" % e)

Parameters

Name Type Description Notes
data_source_id str
data_source_permission_assignment [DataSourcePermissionAssignment]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 No Content -

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

manage_organization_permissions

manage_organization_permissions(organization_permission_assignment)

Manage Permissions for a Organization

Manage Permissions for a Organization

Example

import time
import gooddata_api_client
from gooddata_api_client.api import permissions_api
from gooddata_api_client.model.organization_permission_assignment import OrganizationPermissionAssignment
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = permissions_api.PermissionsApi(api_client)
    organization_permission_assignment = [
        OrganizationPermissionAssignment(
            assignee_identifier=AssigneeIdentifier(
                id="id_example",
                type="user",
            ),
            permissions=[
                "MANAGE",
            ],
        ),
    ] # [OrganizationPermissionAssignment] | 

    # example passing only required values which don't have defaults set
    try:
        # Manage Permissions for a Organization
        api_instance.manage_organization_permissions(organization_permission_assignment)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling PermissionsApi->manage_organization_permissions: %s\n" % e)

Parameters

Name Type Description Notes
organization_permission_assignment [OrganizationPermissionAssignment]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 No Content -

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

manage_workspace_permissions

manage_workspace_permissions(workspace_id, workspace_permission_assignment)

Manage Permissions for a Workspace

Manage Permissions for a Workspace and its Workspace Hierarchy

Example

import time
import gooddata_api_client
from gooddata_api_client.api import permissions_api
from gooddata_api_client.model.workspace_permission_assignment import WorkspacePermissionAssignment
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = permissions_api.PermissionsApi(api_client)
    workspace_id = "workspaceId_example" # str | 
    workspace_permission_assignment = [
        WorkspacePermissionAssignment(
            assignee_identifier=AssigneeIdentifier(
                id="id_example",
                type="user",
            ),
            hierarchy_permissions=[
                "MANAGE",
            ],
            permissions=[
                "MANAGE",
            ],
        ),
    ] # [WorkspacePermissionAssignment] | 

    # example passing only required values which don't have defaults set
    try:
        # Manage Permissions for a Workspace
        api_instance.manage_workspace_permissions(workspace_id, workspace_permission_assignment)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling PermissionsApi->manage_workspace_permissions: %s\n" % e)

Parameters

Name Type Description Notes
workspace_id str
workspace_permission_assignment [WorkspacePermissionAssignment]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 No Content -

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

set_organization_permissions

set_organization_permissions(declarative_organization_permission)

Set organization permissions

Sets organization permissions

Example

import time
import gooddata_api_client
from gooddata_api_client.api import permissions_api
from gooddata_api_client.model.declarative_organization_permission import DeclarativeOrganizationPermission
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = permissions_api.PermissionsApi(api_client)
    declarative_organization_permission = [
        DeclarativeOrganizationPermission(
            assignee=AssigneeIdentifier(
                id="id_example",
                type="user",
            ),
            name="MANAGE",
        ),
    ] # [DeclarativeOrganizationPermission] | 

    # example passing only required values which don't have defaults set
    try:
        # Set organization permissions
        api_instance.set_organization_permissions(declarative_organization_permission)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling PermissionsApi->set_organization_permissions: %s\n" % e)

Parameters

Name Type Description Notes
declarative_organization_permission [DeclarativeOrganizationPermission]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 Organization permissions set. -

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

set_user_group_permissions

set_user_group_permissions(user_group_id, declarative_user_group_permissions)

Set permissions for the user-group

Set effective permissions for the user-group

Example

import time
import gooddata_api_client
from gooddata_api_client.api import permissions_api
from gooddata_api_client.model.declarative_user_group_permissions import DeclarativeUserGroupPermissions
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = permissions_api.PermissionsApi(api_client)
    user_group_id = "userGroupId_example" # str | 
    declarative_user_group_permissions = DeclarativeUserGroupPermissions(
        permissions=[
            DeclarativeUserGroupPermission(
                assignee=AssigneeIdentifier(
                    id="id_example",
                    type="user",
                ),
                name="SEE",
            ),
        ],
    ) # DeclarativeUserGroupPermissions | 

    # example passing only required values which don't have defaults set
    try:
        # Set permissions for the user-group
        api_instance.set_user_group_permissions(user_group_id, declarative_user_group_permissions)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling PermissionsApi->set_user_group_permissions: %s\n" % e)

Parameters

Name Type Description Notes
user_group_id str
declarative_user_group_permissions DeclarativeUserGroupPermissions

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 User-group permissions successfully set. -

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

set_user_permissions

set_user_permissions(user_id, declarative_user_permissions)

Set permissions for the user

Set effective permissions for the user

Example

import time
import gooddata_api_client
from gooddata_api_client.api import permissions_api
from gooddata_api_client.model.declarative_user_permissions import DeclarativeUserPermissions
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = permissions_api.PermissionsApi(api_client)
    user_id = "userId_example" # str | 
    declarative_user_permissions = DeclarativeUserPermissions(
        permissions=[
            DeclarativeUserPermission(
                assignee=AssigneeIdentifier(
                    id="id_example",
                    type="user",
                ),
                name="SEE",
            ),
        ],
    ) # DeclarativeUserPermissions | 

    # example passing only required values which don't have defaults set
    try:
        # Set permissions for the user
        api_instance.set_user_permissions(user_id, declarative_user_permissions)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling PermissionsApi->set_user_permissions: %s\n" % e)

Parameters

Name Type Description Notes
user_id str
declarative_user_permissions DeclarativeUserPermissions

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 User permissions successfully set. -

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

set_workspace_permissions

set_workspace_permissions(workspace_id, declarative_workspace_permissions)

Set permissions for the workspace

Set effective permissions for the workspace

Example

import time
import gooddata_api_client
from gooddata_api_client.api import permissions_api
from gooddata_api_client.model.declarative_workspace_permissions import DeclarativeWorkspacePermissions
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = permissions_api.PermissionsApi(api_client)
    workspace_id = "workspaceId_example" # str | 
    declarative_workspace_permissions = DeclarativeWorkspacePermissions(
        hierarchy_permissions=[
            DeclarativeWorkspaceHierarchyPermission(
                assignee=AssigneeIdentifier(
                    id="id_example",
                    type="user",
                ),
                name="MANAGE",
            ),
        ],
        permissions=[
            DeclarativeSingleWorkspacePermission(
                assignee=AssigneeIdentifier(
                    id="id_example",
                    type="user",
                ),
                name="MANAGE",
            ),
        ],
    ) # DeclarativeWorkspacePermissions | 

    # example passing only required values which don't have defaults set
    try:
        # Set permissions for the workspace
        api_instance.set_workspace_permissions(workspace_id, declarative_workspace_permissions)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling PermissionsApi->set_workspace_permissions: %s\n" % e)

Parameters

Name Type Description Notes
workspace_id str
declarative_workspace_permissions DeclarativeWorkspacePermissions

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 Workspace permissions successfully set. -

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