Amazon Directory Service Directory Service Groups API

The Directory Service Groups API from Amazon Directory Service — 6 operation(s) for directory service groups.

GitHub OpenAPI

Operations 6

POST /Groups/CreateGroup Create Group #
POST /Groups/DeleteGroup Delete Group #
POST /Groups/DescribeGroup Describe Group #
POST /Groups/ListGroups List Groups #
POST /Groups/SearchGroups Search Groups #
POST /Groups/UpdateGroup Update Group #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-directory-service:amazon-directory-service-groups-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-directory-service-groups-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS Directory Service Groups API
  version: '2015-04-16'
  description: Generated from AWS's published Smithy model for AWS Directory Service. 6 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://ds-data.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /Groups/CreateGroup:
    post:
      operationId: CreateGroup
      summary: Create Group
      description: Creates a new group.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateGroupResult'
              example:
                DirectoryId: d-12233abcde
                SAMAccountName: AcctngMail
                SID: S-1-5-33-123
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DsDataAccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '400':
          description: DirectoryUnavailableException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DirectoryUnavailableException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGroupRequest'
            example:
              ClientToken: 550e8400-e29b-41d4-a716-446655440000
              DirectoryId: d-12233abcde
              GroupScope: DomainLocal
              GroupType: Distribution
              OtherAttributes:
                displayName:
                  S: Acctng-mailing-list
                description:
                  S: Accounting dept mailing list
              SAMAccountName: AcctngMail
      tags:
      - Groups
  /Groups/DeleteGroup:
    post:
      operationId: DeleteGroup
      summary: Delete Group
      description: Deletes a group.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteGroupResult'
              example: {}
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DsDataAccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '400':
          description: DirectoryUnavailableException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DirectoryUnavailableException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteGroupRequest'
            example:
              ClientToken: 550e8400-e29b-41d4-a716-446655440000
              DirectoryId: d-12233abcde
              SAMAccountName: marketing
      tags:
      - Groups
  /Groups/DescribeGroup:
    post:
      operationId: DescribeGroup
      summary: Describe Group
      description: Returns information about a specific group.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeGroupResult'
              example:
                DirectoryId: d-12233abcde
                DistinguishedName: DevOpsmail
                GroupScope: Global
                GroupType: Distribution
                OtherAttributes:
                  displayName:
                    S: DevOps mailing list
                  description:
                    S: A group for DevOps email.
                  objectGUID:
                    S: '123456789'
                SAMAccountName: DevOpsMail
                SID: S-1-5-55-678
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DsDataAccessDeniedException'
        '400':
          description: DirectoryUnavailableException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DirectoryUnavailableException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeGroupRequest'
            example:
              DirectoryId: d-12233abcde
              OtherAttributes:
              - displayName
              - description
              - objectGUID
              Realm: example.domain.com
              SAMAccountName: DevOpsMail
      tags:
      - Groups
  /Groups/ListGroups:
    post:
      operationId: ListGroups
      summary: List Groups
      description: Returns group information for the specified directory. This operation supports pagination with the use
        of the NextToken request and response parameters. If more results are available, the ListGroups.NextToken member contains
        a token that you pass in the next call to ListGroups. This retrieves the next set of items. You can also specify a
        maximum number of return results with the MaxResults parameter.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListGroupsResult'
              example:
                DirectoryId: d-12233abcde
                Groups:
                - GroupScope: BuiltinLocal
                  GroupType: Security
                  SAMAccountName: Administrators
                  SID: S-1-5-32-544
                - GroupScope: BuiltinLocal
                  GroupType: Security
                  SAMAccountName: Users
                  SID: S-1-5-32-545
                NextToken: '223456'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DsDataAccessDeniedException'
        '400':
          description: DirectoryUnavailableException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DirectoryUnavailableException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListGroupsRequest'
            example:
              DirectoryId: d-12233abcde
              MaxResults: 123
              NextToken: '123456'
              Realm: examplecorp.com
      tags:
      - Groups
  /Groups/SearchGroups:
    post:
      operationId: SearchGroups
      summary: Search Groups
      description: Searches the specified directory for a group. You can find groups that match the SearchString parameter
        with the value of their attributes included in the SearchString parameter. This operation supports pagination with
        the use of the NextToken request and response parameters. If more results are available, the SearchGroups.NextToken
        member contains a token that you pass in the next call to SearchGroups. This retrieves the next set of items. You
        can also specify a maximum number of return results with the MaxResults parameter.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchGroupsResult'
              example:
                DirectoryId: d-12233abcde
                Groups:
                - GroupScope: BuiltinLocal
                  GroupType: Security
                  SAMAccountName: Administrators
                  SID: S-1-5-32-544
                - GroupScope: BuiltinLocal
                  GroupType: Security
                  SAMAccountName: Users
                  SID: S-1-5-32-545
                NextToken: '223456'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DsDataAccessDeniedException'
        '400':
          description: DirectoryUnavailableException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DirectoryUnavailableException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchGroupsRequest'
            example:
              DirectoryId: d-12233abcde
              MaxResults: 123
              NextToken: '123456'
              Realm: examplecorp.com
              SearchAttributes:
              - GroupScope
              SearchString: Security
      tags:
      - Groups
  /Groups/UpdateGroup:
    post:
      operationId: UpdateGroup
      summary: Update Group
      description: Updates group information.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateGroupResult'
              example: {}
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DsDataAccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '400':
          description: DirectoryUnavailableException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DirectoryUnavailableException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateGroupRequest'
            example:
              ClientToken: 550e8400-e29b-41d4-a716-446655440000
              DirectoryId: d-12233abcde
              GroupScope: Global
              GroupType: Security
              OtherAttributes:
                preferredLanguage:
                  S: English
                co:
                  S: US
              SAMAccountName: GuestsLocal
              UpdateType: REPLACE
      tags:
      - Groups
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: ds-data
  schemas:
    AttributeValue:
      type: object
      properties:
        S:
          type: string
          description: 'Indicates that the attribute type value is a string. For example: "S": "S Group"'
        N:
          type: integer
          description: 'Indicates that the attribute type value is a number. For example: "N": "16"'
        BOOL:
          type: boolean
          description: 'Indicates that the attribute type value is a boolean. For example: "BOOL": true'
        SS:
          type: array
          items:
            type: string
          description: 'Indicates that the attribute type value is a string set. For example: "SS": ["sample_service_class/host.sample.com:1234/sample_service_name_1",
            "sample_service_class/host.sample.com:1234/sample_service_name_2"]'
      description: Exactly one member is set.
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    CreateGroupRequest:
      type: object
      properties:
        DirectoryId:
          type: string
          description: The identifier (ID) of the directory that's associated with the group.
        SAMAccountName:
          type: string
          description: The name of the group.
        GroupType:
          type: string
          enum:
          - Distribution
          - Security
          description: The AD group type. For details, see Active Directory security group type.
        GroupScope:
          type: string
          enum:
          - DomainLocal
          - Global
          - Universal
          - BuiltinLocal
          description: The scope of the AD group. For details, see Active Directory security group scope.
        OtherAttributes:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AttributeValue'
          description: An expression that defines one or more attributes with the data type and value of each attribute.
        ClientToken:
          type: string
          description: A unique and case-sensitive identifier that you provide to make sure the idempotency of the request,
            so multiple identical calls have the same effect as one single call. A client token is valid for 8 hours after
            the first request that uses it completes. After 8 hours, any request with the same client token is treated as
            a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours.
            If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency
            window, Directory Service Data returns an Confli
      required:
      - DirectoryId
      - SAMAccountName
    CreateGroupResult:
      type: object
      properties:
        DirectoryId:
          type: string
          description: The identifier (ID) of the directory that's associated with the group.
        SAMAccountName:
          type: string
          description: The name of the group.
        SID:
          type: string
          description: The unique security identifier (SID) of the group.
    DeleteGroupRequest:
      type: object
      properties:
        DirectoryId:
          type: string
          description: The identifier (ID) of the directory that's associated with the group.
        SAMAccountName:
          type: string
          description: The name of the group.
        ClientToken:
          type: string
          description: A unique and case-sensitive identifier that you provide to make sure the idempotency of the request,
            so multiple identical calls have the same effect as one single call. A client token is valid for 8 hours after
            the first request that uses it completes. After 8 hours, any request with the same client token is treated as
            a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours.
            If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency
            window, Directory Service Data returns an Confli
      required:
      - DirectoryId
      - SAMAccountName
    DeleteGroupResult:
      type: object
      properties: {}
    DescribeGroupRequest:
      type: object
      properties:
        DirectoryId:
          type: string
          description: The Identifier (ID) of the directory associated with the group.
        Realm:
          type: string
          description: The domain name that's associated with the group. This parameter is optional, so you can return groups
            outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD groups are
            returned. This value is case insensitive.
        SAMAccountName:
          type: string
          description: The name of the group.
        OtherAttributes:
          type: array
          items:
            type: string
          description: One or more attributes to be returned for the group. For a list of supported attributes, see Directory
            Service Data Attributes.
      required:
      - DirectoryId
      - SAMAccountName
    DescribeGroupResult:
      type: object
      properties:
        DirectoryId:
          type: string
          description: The identifier (ID) of the directory that's associated with the group.
        Realm:
          type: string
          description: The domain name that's associated with the group.
        SID:
          type: string
          description: The unique security identifier (SID) of the group.
        SAMAccountName:
          type: string
          description: The name of the group.
        DistinguishedName:
          type: string
          description: The distinguished name of the object.
        GroupType:
          type: string
          enum:
          - Distribution
          - Security
          description: The AD group type. For details, see Active Directory security group type.
        GroupScope:
          type: string
          enum:
          - DomainLocal
          - Global
          - Universal
          - BuiltinLocal
          description: The scope of the AD group. For details, see Active Directory security groups.
        OtherAttributes:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AttributeValue'
          description: The attribute values that are returned for the attribute names that are included in the request.
    DirectoryUnavailableException:
      type: object
      properties:
        Message:
          type: string
        Reason:
          type: string
          enum:
          - INVALID_DIRECTORY_STATE
          - DIRECTORY_TIMEOUT
          - DIRECTORY_RESOURCES_EXCEEDED
          - NO_DISK_SPACE
          - TRUST_AUTH_FAILURE
          description: Reason the request failed for the specified directory.
    DsDataAccessDeniedException:
      type: object
      properties:
        Message:
          type: string
        Reason:
          type: string
          enum:
          - IAM_AUTH
          - DIRECTORY_AUTH
          - DATA_DISABLED
          description: Reason the request was unauthorized.
    Group:
      type: object
      properties:
        SID:
          type: string
          description: The unique security identifier (SID) of the group.
        SAMAccountName:
          type: string
          description: The name of the group.
        DistinguishedName:
          type: string
          description: The distinguished name of the object.
        GroupType:
          type: string
          enum:
          - Distribution
          - Security
          description: The AD group type. For details, see Active Directory security group type.
        GroupScope:
          type: string
          enum:
          - DomainLocal
          - Global
          - Universal
          - BuiltinLocal
          description: The scope of the AD group. For details, see Active Directory security groups
        OtherAttributes:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AttributeValue'
          description: An expression of one or more attributes, data types, and the values of a group.
      required:
      - SAMAccountName
    GroupSummary:
      type: object
      properties:
        SID:
          type: string
          description: The unique security identifier (SID) of the group.
        SAMAccountName:
          type: string
          description: The name of the group.
        GroupType:
          type: string
          enum:
          - Distribution
          - Security
          description: The AD group type. For details, see Active Directory security group type.
        GroupScope:
          type: string
          enum:
          - DomainLocal
          - Global
          - Universal
          - BuiltinLocal
          description: The scope of the AD group. For details, see Active Directory security groups.
      required:
      - SID
      - SAMAccountName
      - GroupType
      - GroupScope
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
    ListGroupsRequest:
      type: object
      properties:
        DirectoryId:
          type: string
          description: The identifier (ID) of the directory that's associated with the group.
        Realm:
          type: string
          description: The domain name associated with the directory. This parameter is optional, so you can return groups
            outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD groups are
            returned. This value is case insensitive.
        NextToken:
          type: string
          description: An encoded paging token for paginated calls that can be passed back to retrieve the next page.
        MaxResults:
          type: integer
          description: The maximum number of results to be returned per request.
      required:
      - DirectoryId
    ListGroupsResult:
      type: object
      properties:
        DirectoryId:
          type: string
          description: The identifier (ID) of the directory that's associated with the group.
        Realm:
          type: string
          description: The domain name associated with the group.
        Groups:
          type: array
          items:
            $ref: '#/components/schemas/GroupSummary'
          description: The group information that the request returns.
        NextToken:
          type: string
          description: An encoded paging token for paginated calls that can be passed back to retrieve the next page.
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    SearchGroupsRequest:
      type: object
      properties:
        DirectoryId:
          type: string
          description: The identifier (ID) of the directory that's associated with the group.
        SearchString:
          type: string
          description: The attribute value that you want to search for. Wildcard (*) searches aren't supported. For a list
            of supported attributes, see Directory Service Data Attributes.
        SearchAttributes:
          type: array
          items:
            type: string
          description: One or more data attributes that are used to search for a group. For a list of supported attributes,
            see Directory Service Data Attributes.
        Realm:
          type: string
          description: The domain name that's associated with the group. This parameter is optional, so you can return groups
            outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD groups are
            returned. This value is case insensitive.
        NextToken:
          type: string
          description: An encoded paging token for paginated calls that can be passed back to retrieve the next page.
        MaxResults:
          type: integer
          description: The maximum number of results to be returned per request.
      required:
      - DirectoryId
      - SearchString
      - SearchAttributes
    SearchGroupsResult:
      type: object
      properties:
        DirectoryId:
          type: string
          description: The identifier (ID) of the directory that's associated with the group.
        Realm:
          type: string
          description: The domain that's associated with the group.
        Groups:
          type: array
          items:
            $ref: '#/components/schemas/Group'
          description: The group information that the request returns.
        NextToken:
          type: string
          description: An encoded paging token for paginated calls that can be passed back to retrieve the next page.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
        RetryAfterSeconds:
          type: integer
          description: The recommended amount of seconds to retry after a throttling exception.
      required:
      - Message
    UpdateGroupRequest:
      type: object
      properties:
        DirectoryId:
          type: string
          description: The identifier (ID) of the directory that's associated with the group.
        SAMAccountName:
          type: string
          description: The name of the group.
        GroupType:
          type: string
          enum:
          - Distribution
          - Security
          description: The AD group type. For details, see Active Directory security group type.
        GroupScope:
          type: string
          enum:
          - DomainLocal
          - Global
          - Universal
          - BuiltinLocal
          description: The scope of the AD group. For details, see Active Directory security groups.
        OtherAttributes:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AttributeValue'
          description: An expression that defines one or more attributes with the data type and the value of each attribute.
        UpdateType:
          type: string
          enum:
          - ADD
          - REPLACE
          - REMOVE
          description: The type of update to be performed. If no value exists for the attribute, use ADD. Otherwise, use REPLACE
            to change an attribute value or REMOVE to clear the attribute value.
        ClientToken:
          type: string
          description: A unique and case-sensitive identifier that you provide to make sure the idempotency of the request,
            so multiple identical calls have the same effect as one single call. A client token is valid for 8 hours after
            the first request that uses it completes. After 8 hours, any request with the same client token is treated as
            a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours.
            If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency
            window, Directory Service Data returns an Confli
      required:
      - DirectoryId
      - SAMAccountName
    UpdateGroupResult:
      type: object
      properties: {}
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/directory-service-data/service/2023-05-31/directory-service-data-2023-05-31.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)