topic How to extract all groups using the Viya REST API? in Developers

How to extract all groups using the Viya REST API?

RichardP — Mon, 01 Mar 2021 13:48:49 GMT

Hello,

I am using PROC HTTP to extract the groups from Viya. This appears to work well however I cannot find any documentation to determine the correct content-type header information (I believe this may be undocumented). I have determined that the endpoint is '../identities/groups' and when I examine the text being returned I can see all the groups. What I cannot determine is the custom content-type being returned - this is an excerpt from the results -

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><collection accept="application/vnd.sas.identity.group.summary" count="574" l

imit="50" name="groups" start="0" version="2"><items><groupSummary version="1"><links><link href="/identities/groups/SASAdministrato

rs" method="GET" rel="self" type="application/vnd.sas.identity.group" uri="/identities/groups/SASAdministrators"/><link href="/ident

ities/groups/SASAdministrators" method="GET" rel="alternate" type="application/vnd.sas.identity.group.summary" uri="/identities/grou

ps/SASAdministrators"/><link href="/identities/groups/SASAdministrators" method="DELETE" rel="delete" uri="/identities/groups/SASAdm

inistrators"/><link href="/identities/groups/SASAdministrators" method="PUT" rel="update" type="application/vnd.sas.identity.group"

uri="/identities/groups/SASAdministrators"/>

Can anyone help me specify the correct content type (e.g. Accept:"="application/vnd.sas.identity.group")?

I realize that there are CLI commands for this, I may resort to using those, however this is puzzling me. Any help appreciated!

regards,

Richard

Re: How to extract all groups using the Viya REST API?

joeFurbee — Mon, 01 Mar 2021 14:19:29 GMT

Hi @RichardP,

Nice detective work. You are correct that the identities API is not documented publicly on developer.sas.com. That could change at some point, but not sure if/when.

You've also discovered that you can deconstruct certain CLI calls and work backwards to build API endpoints. This is not supported by SAS Tech Support, but since you've gotten this far, I've confirmed what you see in the XML response. Here is a little more detail on the endpoint:

groups	GET	Link to return a collection of groups.
		URI: /identities/groups
		Response type: `application/vnd.sas.collection`
		Response item type: `application/vnd.sas.identity.group.summary`
		Response item type: `application/vnd.sas.identity.basic`

I hope this helps clear things up.

Re: How to extract all groups using the Viya REST API?

AllanBowe — Mon, 01 Mar 2021 14:23:57 GMT

Hi Richard,

We formulated a macro for this in the @sasjs/core library you can find the documentation here: https://core.sasjs.io/mv__getgroups_8sas.html

/Allan

Re: How to extract all groups using the Viya REST API?

RichardP — Mon, 01 Mar 2021 15:50:06 GMT

The answer in this case was to specify the correct header code -

headers "Accept"="application/json";

Thanks to the ever dependable gentlemen - @joeFurbee and @AllanBowe