Se proporciona el idioma español mediante traducción automática para su comodidad. En caso de alguna inconsistencia, el inglés precede al español.

List all groups

10/23/2024 Colaboradores

PDF

GET /accounts/{account_id}/core/v1/groups

Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.

Parameters

Name	Type	In	Required	Description
account_id	string	path	True	ID of the containing account resource example: {{.Account}}
include	string	query	False	Indicates which fields should be returned when listing a collection. URL examples: "include=id", "include=id,name" OpenAPI examples: "id" example: id,authProvider,authID
limit	string	query	False	Indicates the maximum number of resources to return when listing a collection. URL examples: "limit=2" OpenAPI examples: "2"
filter	string	query	False	Indicates which fields should be matched in order to return a resource when listing a collection. Supported operators are: eq - Equality lt/gt - Less than/Greater than lte/gte - Less than or equals to/Greater than or equals to URL example: "filter=field%20eq%20%27value%27" OpenAPI examples: "field eq 'value'"
orderBy	string	query	False	Indicates the sort order of resource when listing a collection. URL examples: "orderBy=name", "orderBy=name%20desc" OpenAPI examples: "name desc"
skip	string	query	False	Indicates the number of resources to skip over when listing a collection. URL examples: "skip=1" OpenAPI examples: "1"
count	string	query	False	Indicates if the total number of resources should be returned in the metadata object. URL examples: "count=true" OpenAPI examples: "true"
continue		query	False	Indicates the token to resume listing from. URL examples: "continue=" OpenAPI examples: ""</continue>

Name

Type

Required

Description

account_id

string

path

True

ID of the containing account resource

example: {{.Account}}

include

string

query

False

Indicates which fields should be returned when listing a collection.

URL examples: "include=id", "include=id,name"

OpenAPI examples: "id"

example: id,authProvider,authID

limit

string

query

False

Indicates the maximum number of resources to return when listing a collection.

URL examples: "limit=2"

OpenAPI examples: "2"

filter

string

query

False

Indicates which fields should be matched in order to return a resource when listing a collection.

Supported operators are:

eq - Equality
lt/gt - Less than/Greater than
lte/gte - Less than or equals to/Greater than or equals to

URL example: "filter=field%20eq%20%27value%27"

OpenAPI examples: "field eq 'value'"

orderBy

string

query

False

Indicates the sort order of resource when listing a collection.

URL examples: "orderBy=name", "orderBy=name%20desc"

OpenAPI examples: "name desc"

skip

string

query

False

Indicates the number of resources to skip over when listing a collection.

URL examples: "skip=1"

OpenAPI examples: "1"

count

string

query

False

Indicates if the total number of resources should be returned in the metadata object.

URL examples: "count=true"

OpenAPI examples: "true"

continue

query

False

Indicates the token to resume listing from.

URL examples: "continue="

OpenAPI examples: ""</continue>

Response

Status: 200, Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.

Name	Type	Required	Description
items	array[Any of: group_1.0_get_response_body, array[]]	True
metadata	type_astra_metadata_list	True

Name

Type

Required

Description

items

array[Any of: group_1.0_get_response_body, array[]]

True

metadata

type_astra_metadata_list

True

Example response

{
  "type": "application/astra-groups",
  "version": "1.0",
  "items": [
    [
      "11c0cfa1-4f27-4ef7-a21c-cb452fc5c9aa",
      "ldap",
      "CN=Testers,CN=groups,DC=example,DC=com"
    ],
    [
      "e324ec3a-706d-4f57-a95d-1d88c03e7b73",
      "ldap",
      "CN=Admins,CN=groups,DC=example,DC=com"
    ],
    [
      "3070c84d-129b-4017-82a8-2c26a42dd77e",
      "ldap",
      "CN=SREs,CN=groups,DC=example,DC=com"
    ]
  ],
  "metadata": {
    "labels": [],
    "creationTimestamp": "2022-10-06T20:58:16.305662Z",
    "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
    "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
  }
}

Response

Status: 400, Bad request

Name	Type	Required	Description
type	string	True
title	string	True
detail	string	False
status	string	True
correlationID	string	False
invalidParams	array[invalidParams]	False	List of invalid query parameters

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

False

status

string

True

correlationID

string

False

invalidParams

array[invalidParams]

False

List of invalid query parameters

Example response

{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

Response

Status: 500, Internal server error

Name	Type	Required
type	string	True
title	string	True
detail	string	False
status	string	True
correlationID	string	False

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

False

status

string

True

correlationID

string

False

Example response

{
  "type": "https://astra.netapp.io/problems/34",
  "title": "Internal server error",
  "detail": "The server was unable to process this request.",
  "status": "500"
}

Error

Status: 404, Not found

Name	Type	Required
type	string	True
title	string	True
detail	string	False
status	string	True
correlationID	string	False

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

False

status

string

True

correlationID

string

False

Example error response

{
  "type": "https://astra.netapp.io/problems/1",
  "title": "Resource not found",
  "detail": "The resource specified in the request URI wasn't found.",
  "status": "404"
}

Definitions

See Definitions

type_astra_label

Name	Type	Required	Description
name	string	True
value	string	True

Name

Type

Required

Description

name

string

True

value

string

True

type_astra_metadata_update

Client and service-specified metadata associated with the resource. Defined values are:

Conforms to the Astra Metadata Schema If not specified on create, a metadata object will be created with no labels. If not specified on update, the metadata object's labels, creationTimestamp and createdBy, will be preserved without modification.

Name	Type	Required
labels	array[type_astra_label]	False
creationTimestamp	string	False
modificationTimestamp	string	False
createdBy	string	False
modifiedBy	string	False

Name

Type

Required

Description

labels

array[type_astra_label]

False

creationTimestamp

string

False

modificationTimestamp

string

False

createdBy

string

False

modifiedBy

string

False

group_1.0_get_response_body

Name	Type	Required	Description
type	string	True	Media type of the resource. Defined values are: "application/astra-group"
version	string	True	Version of the resource. Defined values are: "1.0"
id	string	True	Globally unique identifier of the resource. Defined values are: Conforms to the UUIDv4 Schema
name	string	True	The name of the group resource. If not specified on create, the value will be set to first Common Name (CN) Relative Distinguished Names (RDN) if found in the authID, authID, otherwise. if not specified on update, the value will be preserved without modification. Defined values are: Minimum length: 1 Maximum length: 256
authProvider	string	True	The authentication provider for the group resource. Defined values are: "ldap"
authID	string	True	The Distinguished Name (DN) for an LDAP group. Defined values are: Minimum length: 1 Maximum length: 256
metadata	type_astra_metadata_update	True	Client and service-specified metadata associated with the resource. Defined values are: Conforms to the Astra Metadata Schema If not specified on create, a metadata object will be created with no labels. If not specified on update, the metadata object's labels, creationTimestamp and createdBy, will be preserved without modification.

Name

Type

Required

Description

type

string

True

Media type of the resource. Defined values are:

"application/astra-group"

version

string

True

Version of the resource. Defined values are:

"1.0"

string

True

Globally unique identifier of the resource. Defined values are:

Conforms to the UUIDv4 Schema

name

string

True

The name of the group resource. If not specified on create, the value will be set to

first Common Name (CN) Relative Distinguished Names (RDN) if found in the authID,
authID, otherwise. if not specified on update, the value will be preserved without modification. Defined values are:
Minimum length: 1
Maximum length: 256

authProvider

string

True

The authentication provider for the group resource. Defined values are:

"ldap"

authID

string

True

The Distinguished Name (DN) for an LDAP group. Defined values are:

Minimum length: 1
Maximum length: 256

metadata

type_astra_metadata_update

True

Client and service-specified metadata associated with the resource. Defined values are:

Conforms to the Astra Metadata Schema If not specified on create, a metadata object will be created with no labels. If not specified on update, the metadata object's labels, creationTimestamp and createdBy, will be preserved without modification.

type_astra_metadata_list

Name	Type	Required
continue	string	False
count	number	False
labels	array[type_astra_label]	False
creationTimestamp	string	False
modificationTimestamp	string	False
createdBy	string	False
modifiedBy	string	False

Name

Type

Required

Description

continue

string

False

count

number

False

labels

array[type_astra_label]

False

creationTimestamp

string

False

modificationTimestamp

string

False

createdBy

string

False

modifiedBy

string

False

invalidParams

Name	Type	Required	Description
name	string	True	Name of the invalid query parameter
reason	string	True	Reason why the query parameter is invalid

Name

Type

Required

Description

name

string

True

Name of the invalid query parameter

reason

string

True

Reason why the query parameter is invalid

List all groups

Creating your file...

Parameters

Response

Response

Response

Error

Definitions