Skip to content

PermissionApi.md

Latest commit

 

History

History
55 lines (34 loc) · 1.49 KB

PermissionApi.md

File metadata and controls

55 lines (34 loc) · 1.49 KB

HyperstackApi.PermissionApi

All URIs are relative to https://infrahub-api.nexgencloud.com/v1

Method HTTP request Description
listPermissions GET /auth/permissions List Permissions

listPermissions

GetPermissionsResponseModel listPermissions()

List Permissions

Retrieves a list of permissions that users can be granted to access a particular resource action. For additional information on permissions, click here.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.PermissionApi();
apiInstance.listPermissions().then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

This endpoint does not need any parameter.

Return type

GetPermissionsResponseModel

Authorization

apiKey

HTTP request headers

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