Contents x
    v1 Creates a subscription on the server
    • 26 Mar 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    v1 Creates a subscription on the server

    • Updated on 26 Mar 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    Article summary

    Put
    /v1/tenants/{tenantId}/projects/{projectId}/subscriptions/{sub}

    creates queues and routing keys so that you can publish and subscribe to a queue.

    Security
    API Key
    Header parameter nameAuthorization

    AWS Cognito Authorizer. Since there are no custom scopes the ID Token must be used for authorization

    Path parameters
    tenantId
    stringRequired

    The RapidIdentity Cloud tenant id

    projectId
    stringRequired

    The project id this service belongs. MUST be builtin or custom

    sub
    stringRequired

    The queue name.

    Body parameters

    Utilized to generate the routing key for the queue. This format is tenants/{tenantId}/projects/{projectId}/topics/{sub}

    topic

    An example for a topic

    {
  "topic": "tenants/1234/projects/custom/topics/alerts"
}
    object
    topic
    string Required
    Responses
    200

    Subscription has been created successfully

    object
    success
    string
    403

    The request is not authorized. Check that an api key exists and that the api key is valid for the tenantId

    object
    error
    string
    500

    Error creating dead letter subscription

    object
    error
    string
    501

    The request does not have a projectId of custom or builtin

    object
    error
    string
    503

    Unable to connect to pubsub service

    object
    error
    string
    Was this article helpful?
    What's Next