com.atlassian.asap.service.api

Annotation Type AsapAuth

@Documented
 @Inherited
 @Retention(value=RUNTIME)
 @Target(value={PACKAGE,TYPE,METHOD})
public @interface AsapAuth

An annotation that declares the intent for a resource to use ASAP-based authentication and authorization.

The annotation's parameters correspond to the corresponding methods that are documented for TokenValidator; see that class for more detail about their meanings. All values default to the same behavior that would be seen if the corresponding method is not called on the TokenValidator.

Since:

2.8

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	audience Explicit audience values to allow, as per TokenValidator.audience(String...).
String[]	impersonationIssuer The issuers that are authorized impersonate other users, as per TokenValidator.impersonationIssuer(String...).
String[]	issuer The issuers that are authorized to execute as per TokenValidator.issuer(String...).
TokenValidator.Policy	policy The enforcement policy to be applied, as per TokenValidator.policy(Policy).
String[]	subject The subjects that are authorized, as per TokenValidator.subject(String...).
boolean	subjectImpersonation Deprecated. as per TokenValidator.subjectImpersonation(boolean)

Element Detail

issuer

public abstract String[] issuer

The issuers that are authorized to execute as per TokenValidator.issuer(String...).

Default:

{}

impersonationIssuer

public abstract String[] impersonationIssuer

The issuers that are authorized impersonate other users, as per TokenValidator.impersonationIssuer(String...).

Default:

{}

subjectImpersonation

@Deprecated
public abstract boolean subjectImpersonation

Deprecated. as per TokenValidator.subjectImpersonation(boolean)

Whether or not to allow subject impersonation, as per TokenValidator.subjectImpersonation(boolean).

Default:

false

subject

public abstract String[] subject

The subjects that are authorized, as per TokenValidator.subject(String...).

Default:

{}

audience

public abstract String[] audience

Explicit audience values to allow, as per TokenValidator.audience(String...).

Default:

{}

policy

public abstract TokenValidator.Policy policy

The enforcement policy to be applied, as per TokenValidator.policy(Policy).

Default:

com.atlassian.asap.service.api.TokenValidator.Policy.REQUIRE