Package io.smallrye.graphql.api.federation.requiresscopes

Annotation Type RequiresScopes

  • @Description("Indicates to composition that the target element is accessible only to the authenticated supergraph users with the appropriate JWT scopes")
@Retention(RUNTIME)
@Experimental("SmallRye GraphQL Federation is still subject to change.")
public @interface RequiresScopes
    directive @requiresScopes(scopes: [[Scope!]!]!) on ENUM | FIELD_DEFINITION | INTERFACE | OBJECT | SCALAR
    See Also:
    federation spec

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      @NonNull ScopeGroup[] scopes  

    • Element Detail

      • scopes

        @NonNull
@Description("List of JWT scopes that must be granted to the user in order to access the underlying element data.")
@NonNull ScopeGroup[] scopes