Resource Access
    • PDF

    Resource Access

    • PDF

    Article summary

    1. Check out a Profile

    This POST method is used to check out a profile.

    POST{{url}}/api/resource-manager/my-resources/profiles/{profileId}/resources/{resourceId}/checkout

    Request Parameters

    The request parameters used in this method are shown in the following table:

    ParameterDescriptionData TypeRequired
    profileId
    Profile IDStringMandatory
    resourceIdResource IDStringMandatory

    Request Example

    curl --location --request POST '{{url}}/api/resource-manager/my-resources/profiles/{profileId}/resources/{resourceId}/checkout' \
    --header 'Authorization: TOKEN {{apiToken}}'

    Response Example 

    Status: 200 OK
    {
      "transactionId": "string",
      "profileId": "string",
      "resourceId": "string",
      "status": "string",
      "statusMsg": "string",
      "checkoutTime": "string",
      "expirationTime": "string",
      "checkInTime": "string",
      "userId": "string",
      "errorMsg": "string"
    }

    2. Get Credentials of Checkedout Profile

    This POST method is used to get the credentials of a checked out profile.

    POST{{url}}/api/resource-manager/my-resources/{transactionId}/credentials

    Request Parameters

    The request parameters used in this method are shown in the following table:

    ParameterDescriptionData TypeRequired
    transactionId
    TransactionId of a checked-out profile.StringMandatory

    Request Example

    curl --location --request POST '{{url}}/api/resource-manager/my-resources/{transactionId}/credentials' \
    --header 'Authorization: TOKEN {{apiToken}}'

    Response Example

    Status: 200 OK
    "string"

    3. Check-in a Profile

    The POST method can be used to check in the user profile that was checked out using the Checkout API.

    POST{{url}}/api/resource-manager/my-resources/{transactionId}/check-in

    Request Parameters

    The request parameters used in this method are shown in the following table:

    ParameterDescriptionData TypeRequired
    transactionId
    TransactionId of a checked-out profile.
    StringMandatory

    Request Example

    curl --location --request POST '{{url}}/api/resource-manager/my-resources/{transactionId}/check-in' \
    --header 'Authorization: TOKEN {{apiToken}}'

    Response Example 

    Status: 200 OK
    {
      "transactionId": "string",
      "profileId": "string",
      "resourceId": "string",
      "status": "string",
      "statusMsg": "string",
      "checkoutTime": "string",
      "expirationTime": "string",
      "checkInTime": "string",
      "userId": "string",
      "errorMsg": "string"
    }

    4. Create Resource Access Approval Request

    This POST method is used to create resource access approval requests.

    POST{{url}}/api/resource-manager/my-resources/profiles/{profileId}/resources/{resourceId}/approvalRequest

    Request Parameters

    The request parameters used in this method are shown in the following table:

    ParameterDescriptionData TypeRequired
    profileId
    Profile IDStringMandatory
    resourceIdResource IDStringMandatory

    Request Example

    curl --location --request POST '{{url}}/api/resource-manager/my-resources/profiles/{profileId}/resources/{resourceId}/approvalRequest' \
    --header 'Authorization: TOKEN {{apiToken}}'

    Response Example 

    Status: 200 OK
    {
      "requestId": "string",
      "tenantId": "string",
      "userId": "string",
      "status": "string",
      "statusText": "string"
    }



    Was this article helpful?

    What's Next