Groups

Lists all groups

GEThttps://api.example.com/api/v1/groups

Response

Happy response.

Body

items*array of CompactGroup (object)

name*string

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

description*string

user_count*integer

Is set to the number of users in this group.

sa_count*integer

Is set to the number of service accounts in this group.

role_count*integer

Is set to the number of roles associated with this group.

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

Request

Response

Creates a new Group.

POSThttps://api.example.com/api/v1/groups

Body

name*string (hq-resource-name)

Sets the unique name of the new group. It must be a valid HQ resource name: it can only contain lowercase alphanumeric characters or hyphens; hyphens cannot appear at the end or start; the length is 63 characters at most.

display_namestring

Sets the display name of the new group. If not provided, the value of "name" will be used.

descriptionstring

Sets the description of the new group.

membersarray of string

Lists principal names (users, service accounts) to be member of this group.

itemsstring

rolesarray of string

Sets the Roles that are bound to this Group by name.

itemsstring

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

Response

Happy response.

Body

name*string

Holds the name of the Group. Must be unique.

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

description*string

roles*array of CompactRole (object)

name*string

Holds the unique name of this role.

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

policy_length*integer

Is set to the number of PermissionStatements in the Policy.

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

users*array of CompactUser (object)

name*string

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

profile*UserProfile (object)

Models a user's Profile.

full_name*string

Contains the users' full name, e.g. Mary Jane Doe.

email_address*string

Contains the users' email address, e.g. mary.jane@doe.net. Note that this is not necessarily the same as the user's name, which often looks like an email address, but is not per se.

is_admin*boolean

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

service_accounts*array of CompactServiceAccount (object)

name*string

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

is_admin*boolean

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

Request

Response

Gets a group by its name.

GEThttps://api.example.com/api/v1/groups/{name}

Path parameters

name*string

Response

Happy response.

Body

name*string

Holds the name of the Group. Must be unique.

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

description*string

roles*array of CompactRole (object)

name*string

Holds the unique name of this role.

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

policy_length*integer

Is set to the number of PermissionStatements in the Policy.

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

users*array of CompactUser (object)

name*string

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

profile*UserProfile (object)

Models a user's Profile.

full_name*string

Contains the users' full name, e.g. Mary Jane Doe.

email_address*string

Contains the users' email address, e.g. mary.jane@doe.net. Note that this is not necessarily the same as the user's name, which often looks like an email address, but is not per se.

is_admin*boolean

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

service_accounts*array of CompactServiceAccount (object)

name*string

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

is_admin*boolean

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

Request

Response

Updates a group.

PATCHhttps://api.example.com/api/v1/groups/{name}

Path parameters

name*string

Body

display_namestring

Updates the display name of the group.

descriptionstring

Updates the Group description, if a value is provided.

rolesarray of string

Sets the Roles that are bound to this Group to the Roles (specified by their names), if provided.

itemsstring

add_membersarray of string

Adds the users/principals (specified by their names) to this group, if provided.

itemsstring

remove_membersarray of string

Removes the users/principals (specified by their names) from this group, if provided. If members are specified in both add_members as well in here, removal wins.

itemsstring

set_membersarray of string

Sets the members of this group to those users/principals (specified by their names) in an absolute fashion, if provided. Cannot be combined with the add_members or remove_members fields.

itemsstring

metadataMetadataPatchRequest (object)

Patches metadata. It has the following semantics:

Absent keys are left untouched;
Null values are deleted;
Non-null values are replaced.

Other propertiesnullable string

Response

Happy response.

Body

name*string

Holds the name of the Group. Must be unique.

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

description*string

roles*array of CompactRole (object)

name*string

Holds the unique name of this role.

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

policy_length*integer

Is set to the number of PermissionStatements in the Policy.

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

users*array of CompactUser (object)

name*string

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

profile*UserProfile (object)

Models a user's Profile.

full_name*string

Contains the users' full name, e.g. Mary Jane Doe.

email_address*string

Contains the users' email address, e.g. mary.jane@doe.net. Note that this is not necessarily the same as the user's name, which often looks like an email address, but is not per se.

is_admin*boolean

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

service_accounts*array of CompactServiceAccount (object)

name*string

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

is_admin*boolean

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

Request

Response

Deletes a group.

DELETEhttps://api.example.com/api/v1/groups/{name}

Path parameters

name*string

Response

Successful deletion.

Request

Response

Updates a group.

PATCHhttps://api.example.com/api/v1/groups/{name}

Path parameters

name*string

Body

display_namestring

Updates the display name of the group.

descriptionstring

Updates the Group description, if a value is provided.

rolesarray of string

Sets the Roles that are bound to this Group to the Roles (specified by their names), if provided.

itemsstring

add_membersarray of string

Adds the users/principals (specified by their names) to this group, if provided.

itemsstring

remove_membersarray of string

Removes the users/principals (specified by their names) from this group, if provided. If members are specified in both add_members as well in here, removal wins.

itemsstring

set_membersarray of string

Sets the members of this group to those users/principals (specified by their names) in an absolute fashion, if provided. Cannot be combined with the add_members or remove_members fields.

itemsstring

metadataMetadataPatchRequest (object)

Patches metadata. It has the following semantics:

Absent keys are left untouched;
Null values are deleted;
Non-null values are replaced.

Other propertiesnullable string

Response

Happy response.

Body

name*string

Holds the name of the Group. Must be unique.

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

description*string

roles*array of CompactRole (object)

name*string

Holds the unique name of this role.

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

policy_length*integer

Is set to the number of PermissionStatements in the Policy.

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

users*array of CompactUser (object)

name*string

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

profile*UserProfile (object)

Models a user's Profile.

full_name*string

Contains the users' full name, e.g. Mary Jane Doe.

email_address*string

Contains the users' email address, e.g. mary.jane@doe.net. Note that this is not necessarily the same as the user's name, which often looks like an email address, but is not per se.

is_admin*boolean

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

service_accounts*array of CompactServiceAccount (object)

name*string

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

is_admin*boolean

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

Request

Response

Creates a new Group.

POSThttps://api.example.com/api/v1/groups

Body

name*string (hq-resource-name)

display_namestring

Sets the display name of the new group. If not provided, the value of "name" will be used.

descriptionstring

Sets the description of the new group.

membersarray of string

Lists principal names (users, service accounts) to be member of this group.

itemsstring

rolesarray of string

Sets the Roles that are bound to this Group by name.

itemsstring

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

Response

Happy response.

Body

name*string

Holds the name of the Group. Must be unique.

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

description*string

roles*array of CompactRole (object)

name*string

Holds the unique name of this role.

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

policy_length*integer

Is set to the number of PermissionStatements in the Policy.

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

users*array of CompactUser (object)

name*string

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

profile*UserProfile (object)

Models a user's Profile.

full_name*string

Contains the users' full name, e.g. Mary Jane Doe.

email_address*string

Contains the users' email address, e.g. mary.jane@doe.net. Note that this is not necessarily the same as the user's name, which often looks like an email address, but is not per se.

is_admin*boolean

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

service_accounts*array of CompactServiceAccount (object)

name*string

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

is_admin*boolean

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

Request

Response

Gets a group by its name.

GEThttps://api.example.com/api/v1/groups/{name}

Path parameters

name*string

Response

Happy response.

Body

name*string

Holds the name of the Group. Must be unique.

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

description*string

roles*array of CompactRole (object)

name*string

Holds the unique name of this role.

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

policy_length*integer

Is set to the number of PermissionStatements in the Policy.

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

users*array of CompactUser (object)

name*string

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

profile*UserProfile (object)

Models a user's Profile.

full_name*string

Contains the users' full name, e.g. Mary Jane Doe.

email_address*string

Contains the users' email address, e.g. mary.jane@doe.net. Note that this is not necessarily the same as the user's name, which often looks like an email address, but is not per se.

is_admin*boolean

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

service_accounts*array of CompactServiceAccount (object)

name*string

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

is_admin*boolean

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

Request

Response