List all LDAP groups
GET /accounts/{account_id}/core/v1/ldapGroups
Returns a JSON array of JSON objects containing the results of the request URL.
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
account_id |
string |
path |
True |
ID of the containing account resource
|
include |
string |
query |
False |
Indicates which fields should be returned when listing a collection. URL examples: "include=id", "include=id,name" OpenAPI examples: "id"
|
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:
URL example: "filter=field%20eq%20%27value%27" OpenAPI examples: "field eq 'value'" |
continue |
query |
False |
Indicates the token to resume listing from. URL examples: "continue= OpenAPI examples: " |
Response
Status: 200, Returns a JSON array of JSON objects containing the results of the request URL.
Name | Type | Required | Description |
---|---|---|---|
items |
array[Any of: ldapGroup_1.0_get_response_body, array[]] |
True |
|
metadata |
True |
Example response
Response
Status: 400, Bad request
Name | Type | Required | Description |
---|---|---|---|
type |
string |
True |
|
title |
string |
True |
|
detail |
string |
True |
|
status |
string |
True |
|
correlationID |
string |
False |
|
invalidParams |
array[invalidParams] |
False |
List of invalid query parameters |
Example response
Response
Status: 403, Forbidden
Name | Type | Required | Description |
---|---|---|---|
type |
string |
True |
|
title |
string |
True |
|
detail |
string |
True |
|
status |
string |
True |
|
correlationID |
string |
False |
Example response
Response
Status: 406, Not acceptable
Name | Type | Required | Description |
---|---|---|---|
type |
string |
True |
|
title |
string |
True |
|
detail |
string |
True |
|
status |
string |
True |
|
correlationID |
string |
False |
Example response
Response
Status: 500, Internal server error
Name | Type | Required | Description |
---|---|---|---|
type |
string |
True |
|
title |
string |
True |
|
detail |
string |
True |
|
status |
string |
True |
|
correlationID |
string |
False |
Example response
Error
Status: 404, Not found
Name | Type | Required | Description |
---|---|---|---|
type |
string |
True |
|
title |
string |
True |
|
detail |
string |
True |
|
status |
string |
True |
|
correlationID |
string |
False |
Example error response
Definitions
See Definitions
type_astra_label
Name | Type | Required | Description |
---|---|---|---|
name |
string |
True |
|
value |
string |
True |
type_astra_metadata
Client and service-specified metadata associated with the resource. Defined values are:
-
Conforms to the Astra Metadata Schema
Name | Type | Required | Description |
---|---|---|---|
labels |
array[type_astra_label] |
True |
|
creationTimestamp |
string |
True |
|
modificationTimestamp |
string |
True |
|
createdBy |
string |
True |
|
modifiedBy |
string |
False |
ldapGroup_1.0_get_response_body
Name | Type | Required | Description |
---|---|---|---|
type |
string |
True |
Media type of the resource. Defined values are:
|
version |
string |
True |
Version of the resource. Defined values are:
|
id |
string |
True |
Globally unique identifier of the resource. Defined values are:
|
cn |
string |
False |
JSON string representing the LDAP group name. Defined values are:
|
dn |
string |
False |
JSON string representing the distinguished name of the LDAP group. Defined values are:
|
metadata |
True |
Client and service-specified metadata associated with the resource. Defined values are:
|
type_astra_metadata_list
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 |