Package com.courier.models.auth

Class AuthIssueTokenParams.Body

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      final String expiresIn() Duration for token expiration.
      final String scope() Available scopes:

      • user_id:<user-id> - Defines which user the token will be scoped to. Multiple can be listed if needed. Ex user_id:pigeon user_id:bluebird.

      • read:messages - Read messages.

      • read:user-tokens - Read user push tokens.

      • write:user-tokens - Write user push tokens.

      • read:brands[:<brand_id>] - Read brands, optionally restricted to a specific brand_id. Examples read:brands, read:brands:my_brand.

      • write:brands[:<brand_id>] - Write brands, optionally restricted to a specific brand_id. Examples write:brands, write:brands:my_brand.

      • inbox:read:messages - Read inbox messages.

      • inbox:write:events - Write inbox events, such as mark message as read.

      • read:preferences - Read user preferences.

      • write:preferences - Write user preferences. Example: user_id:user123 write:user-tokens inbox:read:messages inbox:write:events read:preferences write:preferences read:brands
      final JsonField<String> _expiresIn() Returns the raw JSON value of expiresIn.
      final JsonField<String> _scope() Returns the raw JSON value of scope.
      final Map<String, JsonValue> _additionalProperties()
      final AuthIssueTokenParams.Body.Builder toBuilder()
      final AuthIssueTokenParams.Body validate()
      final Boolean isValid()
      Boolean equals(Object other)
      Integer hashCode()
      String toString()
      final static AuthIssueTokenParams.Body.Builder builder() Returns a mutable builder for constructing an instance of Body.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • expiresIn

         final String expiresIn()

        Duration for token expiration. Accepts various time formats:

        • "2 hours" - 2 hours from now

        • "1d" - 1 day

        • "3 days" - 3 days

        • "10h" - 10 hours

        • "2.5 hrs" - 2.5 hours

        • "1m" - 1 minute

        • "5s" - 5 seconds

        • "1y" - 1 year

      • scope

         final String scope()

        Available scopes:

        • user_id:<user-id> - Defines which user the token will be scoped to. Multiple can be listed if needed. Ex user_id:pigeon user_id:bluebird.

        • read:messages - Read messages.

        • read:user-tokens - Read user push tokens.

        • write:user-tokens - Write user push tokens.

        • read:brands[:<brand_id>] - Read brands, optionally restricted to a specific brand_id. Examples read:brands, read:brands:my_brand.

        • write:brands[:<brand_id>] - Write brands, optionally restricted to a specific brand_id. Examples write:brands, write:brands:my_brand.

        • inbox:read:messages - Read inbox messages.

        • inbox:write:events - Write inbox events, such as mark message as read.

        • read:preferences - Read user preferences.

        • write:preferences - Write user preferences. Example: user_id:user123 write:user-tokens inbox:read:messages inbox:write:events read:preferences write:preferences read:brands

      • _scope

         final JsonField<String> _scope()

        Returns the raw JSON value of scope.

        Unlike scope, this method doesn't throw if the JSON field has an unexpected type.