Contents x
    Creates a subscription on the server
    • 26 Mar 2024
    • 2 Minutes to read
    • Print
    • Dark
      Light
    Contents

    Creates a subscription on the server

    • Updated on 26 Mar 2024
    • 2 Minutes to read
    • Print
    • Dark
      Light
    Article summary

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

    Creates queues and routing keys so that you can publish and subscribe to a queue(s). {sub} must not contain builtin_ or custom_ as these are reserved words

    Security
    API Key
    Header parameter nameAuthorization

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

    Header parameters
    Content-Type
    stringRequired
    Path parameters
    tenantId
    stringRequired

    The RapidIdentity Cloud tenant id

    projectId
    stringRequired

    The project id this service belongs (i.e. sm, idhub, ric)

    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}. {sub} must not contain builtin_ or custom_ as these are reserved words

    topic

    An example for a topic

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

    An instance of a Subscription is returned

    Headers
    Content-Type
    string
    Content-Length
    string
    Cache-Control
    string
    object
    name
    string
    topic
    string
    400

    An issue with how the request was formatted

    Headers
    Content-Type
    string
    Content-Length
    string
    Cache-Control
    string
    Expand All
    object
    error
    object

    The error message description

    errors
    Array of object

    The more detailed information about the error message

    object
    domain
    string

    The service where the error occured. i.e. sm, idhub

    reason
    string

    The reason for the error based on Identity Automation common error codes

    message
    string

    Additional details about the error

    locationType
    string

    The specific location where the error occurred. i.e. parameter, content

    location
    string

    The higher level location of what was trying to be accessed. i.e. pullMessages, publishMessage

    code
    string

    The http status code

    message
    string

    Additional details about the error

    401

    The request is not authorized. Ensure you are using an ID Token in your request and it is not expired

    Headers
    Content-Type
    string
    Content-Length
    string
    Cache-Control
    string
    Expand All
    object
    error
    object

    The error message description

    errors
    Array of object

    The more detailed information about the error message

    object
    domain
    string

    The service where the error occured. i.e. sm, idhub

    reason
    string

    The reason for the error based on Identity Automation common error codes

    message
    string

    Additional details about the error

    locationType
    string

    The specific location where the error occurred. i.e. parameter, content

    location
    string

    The higher level location of what was trying to be accessed. i.e. pullMessages, publishMessage

    code
    string

    The http status code

    message
    string

    Additional details about the error

    403

    The authorization token does not have access to the RapidIdentity Cloud Tenant. Ensure the tenantId used for authentication is the same one used in this request.

    Headers
    Content-Type
    string
    Content-Length
    string
    Cache-Control
    string
    Expand All
    object
    error
    object

    The error message description

    errors
    Array of object

    The more detailed information about the error message

    object
    domain
    string

    The service where the error occured. i.e. sm, idhub

    reason
    string

    The reason for the error based on Identity Automation common error codes

    message
    string

    Additional details about the error

    locationType
    string

    The specific location where the error occurred. i.e. parameter, content

    location
    string

    The higher level location of what was trying to be accessed. i.e. pullMessages, publishMessage

    code
    string

    The http status code

    message
    string

    Additional details about the error

    503

    Unable to connect to pubsub service

    Headers
    Content-Type
    string
    Content-Length
    string
    Cache-Control
    string
    Expand All
    object
    error
    object

    The error message description

    errors
    Array of object

    The more detailed information about the error message

    object
    domain
    string

    The service where the error occured. i.e. sm, idhub

    reason
    string

    The reason for the error based on Identity Automation common error codes

    message
    string

    Additional details about the error

    locationType
    string

    The specific location where the error occurred. i.e. parameter, content

    location
    string

    The higher level location of what was trying to be accessed. i.e. pullMessages, publishMessage

    code
    string

    The http status code

    message
    string

    Additional details about the error

    Was this article helpful?
    What's Next