Amazon Web Services, Inc.

Amazon Chime SDK Identity

The Amazon Chime SDK Identity APIs in this section allow software developers to create and manage unique instances of their messaging applications. These APIs…

Communication#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Amazon Chime SDK Identity APIs in this section allow software developers to create
and manage unique instances of their messaging applications. These APIs provide the
overarching framework for creating and sending messages. For more information about the
identity APIs, refer to Amazon Chime SDK identity .

Endpoints 29

  • GETList app instances/app-instances?max-results=0&next-token=stringLists all Amazon Chime AppInstance s created under a single AWS account.
  • POSTCreate app instance/app-instancesCreates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency…
  • GETList app instance admins/app-instances/:AppInstanceArn/admins?max-results=0&next-token=stringReturns a list of the administrators in the AppInstance .
  • POSTCreate app instance admin/app-instances/:AppInstanceArn/adminsPromotes an AppInstanceUser or AppInstanceBot to an AppInstanceAdmin . The promoted entity can perform the following actions. ChannelModerator actions across…
  • GETList app instance bots/app-instance-bots?app-instance-arn=string&max-results=0&next-token=stringLists all AppInstanceBots created under a single AppInstance .
  • POSTCreate app instance bot/app-instance-botsCreates a bot under an Amazon Chime AppInstance . The request consists of a unique Configuration and Name for that bot.
  • GETList app instance users/app-instance-users?app-instance-arn=string&max-results=0&next-token=stringList all AppInstanceUsers created under a single AppInstance .
  • POSTCreate app instance user/app-instance-usersCreates a user under an Amazon Chime AppInstance . The request consists of a unique appInstanceUserId and Name for that user.
  • GETDescribe app instance/app-instances/:AppInstanceArnReturns the full details of an AppInstance .
  • PUTUpdate app instance/app-instances/:AppInstanceArnUpdates AppInstance metadata.
  • DELETEDelete app instance/app-instances/:AppInstanceArnDeletes an AppInstance and all associated data asynchronously.
  • GETDescribe app instance admin/app-instances/:AppInstanceArn/admins/:AppInstanceAdminArnReturns the full details of an AppInstanceAdmin .
  • DELETEDelete app instance admin/app-instances/:AppInstanceArn/admins/:AppInstanceAdminArnDemotes an AppInstanceAdmin to an AppInstanceUser or AppInstanceBot . This action does not delete the user.
  • GETDescribe app instance bot/app-instance-bots/:AppInstanceBotArnThe AppInstanceBot's information.
  • PUTUpdate app instance bot/app-instance-bots/:AppInstanceBotArnUpdates the name and metadata of an AppInstanceBot .
  • DELETEDelete app instance bot/app-instance-bots/:AppInstanceBotArnDeletes an AppInstanceBot .
  • GETDescribe app instance user/app-instance-users/:AppInstanceUserArnReturns the full details of an AppInstanceUser .
  • PUTUpdate app instance user/app-instance-users/:AppInstanceUserArnUpdates the details of an AppInstanceUser . You can update names and metadata.
  • DELETEDelete app instance user/app-instance-users/:AppInstanceUserArnDeletes an AppInstanceUser .
  • GETDescribe app instance user endpoint/app-instance-users/:AppInstanceUserArn/endpoints/:EndpointIdReturns the full details of an AppInstanceUserEndpoint .
  • PUTUpdate app instance user endpoint/app-instance-users/:AppInstanceUserArn/endpoints/:EndpointIdUpdates the details of an AppInstanceUserEndpoint . You can update the name and AllowMessage values.
  • DELETEDeregister app instance user endpoint/app-instance-users/:AppInstanceUserArn/endpoints/:EndpointIdDeregisters an AppInstanceUserEndpoint .
  • GETGet app instance retention settings/app-instances/:AppInstanceArn/retention-settingsGets the retention settings for an AppInstance .
  • PUTPut app instance retention settings/app-instances/:AppInstanceArn/retention-settingsSets the amount of time in days that a given AppInstance retains data.
  • GETList app instance user endpoints/app-instance-users/:AppInstanceUserArn/endpoints?max-results=0&next-token=stringLists all the AppInstanceUserEndpoints created under a single AppInstanceUser .
  • POSTRegister app instance user endpoint/app-instance-users/:AppInstanceUserArn/endpointsRegisters an endpoint under an Amazon Chime AppInstanceUser . The endpoint receives messages for a user. For push notifications, the endpoint is a mobile…
  • GETList tags for resource/tags?arn=stringLists the tags applied to an Amazon Chime SDK identity resource.
  • POSTUntag resource/tags?operation=untag-resourceRemoves the specified tags from the specified Amazon Chime SDK identity resource.
  • PUTPut app instance user expiration settings/app-instance-users/:AppInstanceUserArn/expiration-settingsSets the number of days before the AppInstanceUser is automatically deleted. A background process deletes expired AppInstanceUsers within 6 hours of…

API details

Base URL
https://identity-chime.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
29 operations on 13 pathsGET 12PUT 6POST 6DELETE 5
Description format
AWS Smithy model, API version 2021-04-20

How to test the Amazon Chime SDK Identity in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Chime SDK Identity collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List app instances” (GET /app-instances?max-results=0&next-token=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Chime SDK Identity?

The Amazon Chime SDK Identity APIs in this section allow software developers to create and manage unique instances of their messaging applications. These APIs… It is listed under Communication and has 29 endpoints.

Who publishes the Amazon Chime SDK Identity?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Chime SDK Identity?

Requests go to https://identity-chime.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Chime SDK Identity?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Chime SDK Identity have?

29 operations on 13 paths (12 GET, 6 PUT, 6 POST, 5 DELETE).

Is forking the Amazon Chime SDK Identity free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.