@java.lang.annotation.Target(value: [ElementType.TYPE, ElementType.METHOD]) @java.lang.annotation.Retention(value: RetentionPolicy.RUNTIME) @java.lang.annotation.Documented @interface RequireApiKey
Annotation to check that a valid api key has been provided.
| Type Params | Return Type | Name and description |
|---|---|---|
|
abstract boolean |
anyRole()If this is set to true, then only one of the roles needs to be present for the request to be allowed. |
|
abstract boolean |
anyScope()If this is set to true, then only one of the scopes needs to be present for the request to be allowed. |
|
abstract boolean |
eitherRolesOrScopes()If this is set to true, then only one of the roles or scopes needs to be present for the request to be allowed. |
|
abstract java.lang.String |
projectIdParam() |
|
abstract java.lang.String |
redirectAction() |
|
abstract java.lang.String |
redirectController() |
|
abstract java.lang.String[] |
roles()Only taken into account for JWT authentications @return |
|
abstract java.lang.String[] |
rolesFromProperty()Provide a Grails configuration property name to get the roles from. |
|
abstract java.lang.String[] |
scopes()Only taken into account for JWT authentications. |
|
abstract java.lang.String[] |
scopesFromProperty()Provide a Grails configuration property name to get the scopes from. |
|
abstract boolean |
useCustomFilter() |
| Methods inherited from class | Name |
|---|---|
class java.lang.Object |
java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
If this is set to true, then only one of the roles needs to be present for the request to be allowed. If this is false, then all listed roles must be present. @return
If this is set to true, then only one of the scopes needs to be present for the request to be allowed. If this is false, then all listed scopes must be present. @return
If this is set to true, then only one of the roles or scopes needs to be present for the request to be allowed. If this is false, then both roles and scopes must be present. @return
Only taken into account for JWT authentications @return
Provide a Grails configuration property name to get the roles from. Combined with security.jwt.roles and roles parameter @return
Only taken into account for JWT authentications. Combined with security.jwt.scopes @return
Provide a Grails configuration property name to get the scopes from. Combined with security.jwt.scopes and scopes parameter @return