Breadcrumbs

API - Get Entitlement

Purpose

To get the entitlement by user, asset and account using Sectona API interface.

Accessing the API

Endpoint: /API/APP/APP007/GetEntitlement

HTTP METHOD

POST

Parameters

Parameters

Data type

Required

Description

EntitlementType

String

Yes

User
Account
Asset

Assettype

String

OPTIONAL

Not Required if User type

AssetHost

String

OPTIONAL

Not Required if User type

DBInstance

String

OPTIONAL

Not Required if User type

AccountName

String

OPTIONAL

Required if Account type

AccountType

String

OPTIONAL

Required if Account type (Local, AD Account)

Username

String

OPTIONAL

Required if User type

AuthenticationType

String

OPTIONAL

Required if User type

DirectoryStore

String

OPTIONAL

Required if User type

Instance

String

YES

 Instance name

Sample Request (JSON)

{
     "EntitlementType":"String",
     "Assettype":"String",
     "AssetHost":"String",
     "DBInstance":"String",
     "AccountName":"String",
     "AccountType":"String",
     "Username":"String",
     "AuthenticationType":"String",
     "DirectoryStore":"String",
     "Instance":"String",
}

Sample Response (JSON)

{
    "Version":"3.8.0.0",
	"IsSuccess": true,
	"LogCode":"0",
	"Result":[{
	
     "Asset Category":"String",
     "Asset Type":"String",
     "Host Name":"String",
     "IP Address":"String",
     "Account Type":"String",
     "Account":"String",
     "Domain":"String",
     "Username":"String",
     "Policy Name":"String",
     "User Group":"String",
     "Account Group":"String",
     "Entitlement Type":"String",
     
}]	"StatusCode":"Accepted",
	"Timestamp":"03 Jun 2019 12:25:16 GMT 05:30:00"
}

Standard Error Response Codes

Error Code

Error Description

011649

Current user do not have permission to take action

011651

The authorization header is either empty or not basic

011673

Invalid credentials

011674

Invalid credentials

011675

Unable to validate request

011683

Invalid instance name

011803

Unable to insert api log details

032417

Unable to get entitlement information

011656

Invalid directory store

011671

Invalid account name

011685

Unable to get asset information

011690

Account does not belongs to asset

011805

Unable to get user group

011853

Requested asset is not valid