Skip to content

Return endUserDisplayName and endUserDisplayDescription in group API operations #454

@mbarneyjr

Description

@mbarneyjr

Describe the feature request?

The Okta client, although not documented, does support passing endUserDisplayName and endUserDisplayDescription:

const group = await client.groupApi.createGroup({
  group: {
    profile: {
      name: "foo",
      description: "bar",
      endUserDisplayName: "test name",
      endUserDisplayDescription: "test description",
    },
  },
});

When retrieving the group, it is not returned:

const group = await client.groupApi.getGroup({
  groupId: "...",
});
console.log(JSON.stringify(group, null, 2));
// outputs
{
  ...
  "profile": {
    "description": "barneybarneybarney",
    "name": "barneybarney"
  },
  ...
}

If I query the API directly, I do see those fields returned:

$ curl https://login.barney.dev/api/v1/groups/... -H "Authorization: SSWS ..." | jq
{
  ...
  "profile": {
    "name": "foo",
    "description": "bar",
    "endUserDisplayName": "test name",
    "endUserDisplayDescription": "test description"
  },
  ...
}

New or Affected Resource(s)

Okta Groups

Provide a documentation link

No response

Additional Information?

No response

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions