POST Codesign/GetRight

Returns caller rights for a given CodeSign Protect object.

Requirements

  • Permissions:  None.
  • Token scope:  Codesign:Manage

Headers

  • Content type: Content-Type:application/json.

  • Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.

Parameters

Input parameters

Name

Description

Dn

The Distinguished Name (DN) of an object. Use the appropriate syntax. For example, in Postman:

  • Application: \\VED\\Code Signing\\Signing Applications\\[YourSgnApp].
  • ApplicationCollection: \\VED\\Code Signing\\Signing Applications\\[YourSgnAppCollection].
  • Project: \\VED\\Code Signing\\Projects\\[YourPrjName].

Returns

Response description

Name

Description

HTTP 200

For valid requests, this call returns a HTTP 200 message and the following data in the message body:

  • Error: Appears only when Success is false. An error message that accompanies the Result. Check your payload input values.

  • Rights: The SignRight object value or the sum of various rights for the identity. For example, a value of 72 ,means the identity has Owner (8) plus ApproveUse (64) rights.

  • Result: The Result code of this API call. For more information, see Sign Result Codes.

  • Success: The result of this API call: A value of false indicates the request failed due to an Error. Otherwise, true.

HTTP 400

For invalid requests, this call returns HTTP 400 Bad Request and the following data in the message body:

  • error: The reason for the error.
  • error_description: If available, additional information about how to retry the request.

Example: Show the caller's rights for an environment

The following example shows that the caller has the rights of a Code Signing Administrator.

Request

POST https://codesign.venafi.example//vedsdk/Codesign/GetRight
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "Dn":"\\VED\\Code Signing\\Projects\\Sample\\Development Environment"
}

Response

HTTP/1.1 200 OK
{
   "Result":1,
   "Rights":1,
   "Success":true
}