UiPath Cloud Orchestrator API is now simplified :)

Hi All,

The API Authentication updates to our Cloud Platform are now live and simplify the usage of Orchestrator API.

The new method gives each user a key, which can be used to generate 24-hour access tokens that may be revoked or refreshed at any time. Here is the documentation to help you understand where to find these tokens and the API calls that use them:

Orchestrator Documentation

Postman Collection

Note that this method is only used for https://platform.uipath.com. On-premise Orchestrators can still use Tenant, Username, and Password for authentication.

23 Likes

Wow great i need this one @loginerror

2 Likes

Thanks it’s very useful @loginerror :ok_hand::ok_hand:

1 Like

Perfect, this is what I have expected :ok_hand::ok_hand::ok_hand:

So in order to get the access token you need the refresh token (or the user key now), but it refreshes every 24h. How can you get that besides getting into the Api Acess menu?

Actually, refresh token never expires (unless revoked from the settings).

It’s the access token that expires every 24 hours.

Ahh cool, got confused. Thanks!

1 Like

Hi ,

This is good news and is less confusing, I have already tested it and it works like charm. :slight_smile:

regards,

1 Like

This site can’t be reached

docs.uipath.com ’s server IP address could not be found.

  • [Try running Windows Network Diagnostics](javascript:diagnoseErrors()).

DNS_PROBE_FINISHED_NXDOMAIN

Why do I get this error while trying to access the documentation?

Hi @josephivann

Does it still happen? Could you test if it works on different devices on the same network and different network on the same device?

1 Like

hi sorry for the late response. It is now working for me. Thank you.

1 Like

So any user (Apart from Organization Owner or Organization Administrator) can access Orchestrator API service Right…?

Do we need to have any special access for that user to be granted by the administrator…?

Hi @9942055603

I believe so, yes. And then the set of possible actions depends on the Role the user is assigned to.

More info here:

image

Thanks for your clarity… :grinning:

Is that applicable for all the versions of cloud orchestrators…?

It is true for all Orchestrator Cloud instances, because they run on the same version.

Hi @loginerror, Currently i am trying to access the cloud api from postman. I am receiving the access token but when using the access token in subsequent api’s. i am receiving the following error,

{
    "message": "You are not authenticated!",
    "errorCode": 0,
    "result": null,
    "targetUrl": null,
    "success": false,
    "error": {
        "code": 0,
        "message": "You are not authenticated!",
        "details": "You should be authenticated (sign in) in order to perform this operation.",
        "validationErrors": null
    },
    "unAuthorizedRequest": false,
    "__abp": true
}

Postman Request

    curl --location --request GET 'https://platform.uipath.com/[TenantName]/[Folder Name]/odata/Settings/UiPath.Server.Configuration.OData.GetLicense' \
    --header 'X-UIPATH-TenantName: [TenantName]' \
    --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsI(...)' \

Hi @Rajesh_Manikandan

Please do not post your tokens like that, it’s dangerous. I’d suggest you start by revoking your user token and start again.

For your postman request, it should actually be:

https://platform.uipath.com/[Account Logical Name]/[Tenant Logical Name]/odata/Settings/UiPath.Server.Configuration.OData.GetLicense

Could that be it?

That’s not an actual token. I have edited that. :neutral_face:

It worked! Thanks :+1:

1 Like

hi I am experiencing this error today.

1 Like