topic Re: New API, post method not working in ExtremeCloud IQ Developer Community

New API, post method not working

grech659 — Wed, 08 Dec 2021 09:57:45 GMT

Hey guys,

I've been playing around with the new API and absolutely loving it. Big improvement over the old one!

Everything seem to be working great except post methods. For example, I'm trying to grant and external user access following the below documentation.
Swagger UI

Extremecloudiq

remove preview

Swagger UI

View this on Extremecloudiq >

I'm using the following URL - https://api.extremecloudiq.com/users/external

Not matter what I put in the body I always get an 400 error as per below.

{
"error_code": "INVALID_ARGUMENT",
"error_id": "b4c66c4cc3284a6dbb66234c17334d5d",
"error_message": "INVALID_ARGUMENT: core.service.invalid.data"
}

I've tried multiple different user accounts but always the same outcome. Any known issues at all?

Any help is much appreciated.

Cheers

Update: Including Raw Output with username replaced.

POST /users/external HTTP/1.1
Authorization: Bearer [Placeholder token]
Host: api.extremecloudiq.com
Content-Type: application/json
Content-Length: 116

{
"login_name": "xxxx.xxxx@xxxx.nz",
"user_role": "ADMINISTRATOR",
"enable_api_access": "true"
}

Re: New API, post method not working

Kurt_Semba — Wed, 08 Dec 2021 12:24:52 GMT

Congratulations on being the first one to post a question into our new API community 🙂

I just gave this API call a try using the Swagger page and it worked fined. I tried it with two accounts (email addresses) from colleagues who have XIQ accounts but are not yet added to my demo XIQ. I gave them both the ADMINISTRATOR role and one I allowed API access as well, the other one I set that parameter to false. Example curl command that Swagger auto-generated:

curl -X POST "https://api.extremecloudiq.com/users/external" -H "accept: application/json" -H "Authorization: Bearer bearer_token_removed" -H "Content-Type: application/json" -d "{\"login_name\":\"colleague1_real_email_removed@extremenetworks.com\",\"user_role\":\"ADMINISTRATOR\",\"enable_api_access\":\"true\"}"

Are you logged in as an Administrator with full access rights to the API? I'm logged in with my main account - the email account that created my demo XIQ account.
That external email that you are trying to add: is this an already existing user within some other XIQ account? I don't think you can add just any random email and invite that person. It probably needs to be an already registered user with some XIQ account (not yours, of course).

Kurt

Re: New API, post method not working

grech659 — Wed, 08 Dec 2021 17:15:45 GMT

Hey Kurt,

Thanks for the response. I've just done some more playing around and think I have isolated the issue.

It seems to be working fine if I try with a login local to that instance. I'm currently trying with guest admin account(Administrator with API enabled) with access token being generated with the /account/:switch method which is causing the issue. So seems guest admins with API access enabled has no write/post access?

Cheers

Re: New API, post method not working

Kurt_Semba — Wed, 08 Dec 2021 17:27:31 GMT

Thanks for sharing your findings. That acutally makes sense: a guest admin should not have the capability to add external admins to the XIQ account. Is that "guest admin" a local admin with the "Guest Management" role?

Re: New API, post method not working

grech659 — Wed, 08 Dec 2021 17:35:56 GMT

Sorry, not guest admin. I mean external admin 🙂

Re: New API, post method not working

Kurt_Semba — Wed, 08 Dec 2021 19:55:01 GMT

When you authenticate to the XIQ API you get logged into your "main" account. This is the account in which are a a normal admin and not an "external admin". Using that authentication token, you should be able to make all API calls in your main account.

If you want to then make API calls in a different account in which you have been added as "external admin" you will first have to switch to that account. You can use /account/external to list all account IDs that you are able to switch to. Then use /account/:switch to actually switch your context to this account (you will get a new token to use for subsequent calls).

Re: New API, post method not working

grech659 — Wed, 08 Dec 2021 21:02:39 GMT

That is exactly what I'm currently doing. This issue seems to be that the access token generated by the /account/:switch method isnt allowing me to post anything to the new context which is causing the error below.

{
"error_code": "INVALID_ARGUMENT",
"error_id": "b4c66c4cc3284a6dbb66234c17334d5d",
"error_message": "INVALID_ARGUMENT: core.service.invalid.data"
}

If I swap the access token(and not touch the body) out for one that was generated by a local admin account then it works perfectly fine.

Re: New API, post method not working

grech659 — Thu, 09 Dec 2021 22:50:38 GMT

So I've done a bit more testing. This can be replicated in swagger by following:

Testing a local account(Works)
POST /login - with local username and password
Set authorization token to result of above
POST /users/external - successfully added external user

Testing on external admin(Doesn't work)
POST /login - with the external admins username and password
Set authorization token to result of above
GET /account/external - to get a list of available instances to switch to
POST /account/:switch?id=<id from above GET method>
Update authorization token to result of above so its authorized to the new instance
POST /users/external - Error 400 - doesn't seem exclusive to just the POST /user/external method as well. Seems most post methods dont work

Running /auth/permissions on the new access token generated by POST /account/:switch show all the same permissions as the token generated by local account. Same with running POST /auth/permissions/:check and passing it the POST /user/external method you get code 200 back showing you do have the permissions for it.

So seems like a bug?