public class LookupDeveloperIdentityRequest extends AmazonWebServiceRequest implements Serializable
Retrieves the IdentityID
associated with a
DeveloperUserIdentifier
or the list of
DeveloperUserIdentifier
values associated with an
IdentityId
for an existing identity. Either
IdentityID
or DeveloperUserIdentifier
must not be
null. If you supply only one of these values, the other value will be
searched in the database and returned as a part of the response. If you
supply both, DeveloperUserIdentifier
will be matched against
IdentityID
. If the values are verified against the database, the
response returns both values and is the same as the request. Otherwise a
ResourceConflictException
is thrown.
LookupDeveloperIdentity
is intended for low-throughput control
plane operations: for example, to enable customer service to locate an
identity ID by username. If you are using it for higher-volume operations
such as user authentication, your requests are likely to be throttled.
GetOpenIdTokenForDeveloperIdentity is a better option for
higher-volume operations for user authentication.
You must use AWS Developer credentials to call this API.
Constructor and Description |
---|
LookupDeveloperIdentityRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
String |
getDeveloperUserIdentifier()
A unique ID used by your backend authentication process to identify a
user.
|
String |
getIdentityId()
A unique identifier in the format REGION:GUID.
|
String |
getIdentityPoolId()
An identity pool ID in the format REGION:GUID.
|
Integer |
getMaxResults()
The maximum number of identities to return.
|
String |
getNextToken()
A pagination token.
|
int |
hashCode() |
void |
setDeveloperUserIdentifier(String developerUserIdentifier)
A unique ID used by your backend authentication process to identify a
user.
|
void |
setIdentityId(String identityId)
A unique identifier in the format REGION:GUID.
|
void |
setIdentityPoolId(String identityPoolId)
An identity pool ID in the format REGION:GUID.
|
void |
setMaxResults(Integer maxResults)
The maximum number of identities to return.
|
void |
setNextToken(String nextToken)
A pagination token.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
LookupDeveloperIdentityRequest |
withDeveloperUserIdentifier(String developerUserIdentifier)
A unique ID used by your backend authentication process to identify a
user.
|
LookupDeveloperIdentityRequest |
withIdentityId(String identityId)
A unique identifier in the format REGION:GUID.
|
LookupDeveloperIdentityRequest |
withIdentityPoolId(String identityPoolId)
An identity pool ID in the format REGION:GUID.
|
LookupDeveloperIdentityRequest |
withMaxResults(Integer maxResults)
The maximum number of identities to return.
|
LookupDeveloperIdentityRequest |
withNextToken(String nextToken)
A pagination token.
|
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public String getIdentityPoolId()
An identity pool ID in the format REGION:GUID.
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
An identity pool ID in the format REGION:GUID.
public void setIdentityPoolId(String identityPoolId)
An identity pool ID in the format REGION:GUID.
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
identityPoolId
- An identity pool ID in the format REGION:GUID.
public LookupDeveloperIdentityRequest withIdentityPoolId(String identityPoolId)
An identity pool ID in the format REGION:GUID.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
identityPoolId
- An identity pool ID in the format REGION:GUID.
public String getIdentityId()
A unique identifier in the format REGION:GUID.
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
A unique identifier in the format REGION:GUID.
public void setIdentityId(String identityId)
A unique identifier in the format REGION:GUID.
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
identityId
- A unique identifier in the format REGION:GUID.
public LookupDeveloperIdentityRequest withIdentityId(String identityId)
A unique identifier in the format REGION:GUID.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
identityId
- A unique identifier in the format REGION:GUID.
public String getDeveloperUserIdentifier()
A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users.
Constraints:
Length: 1 - 1024
A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users.
public void setDeveloperUserIdentifier(String developerUserIdentifier)
A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users.
Constraints:
Length: 1 - 1024
developerUserIdentifier
- A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users.
public LookupDeveloperIdentityRequest withDeveloperUserIdentifier(String developerUserIdentifier)
A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 1024
developerUserIdentifier
- A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users.
public Integer getMaxResults()
The maximum number of identities to return.
Constraints:
Range: 1 - 60
The maximum number of identities to return.
public void setMaxResults(Integer maxResults)
The maximum number of identities to return.
Constraints:
Range: 1 - 60
maxResults
- The maximum number of identities to return.
public LookupDeveloperIdentityRequest withMaxResults(Integer maxResults)
The maximum number of identities to return.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 1 - 60
maxResults
- The maximum number of identities to return.
public String getNextToken()
A pagination token. The first call you make will have
NextToken
set to null. After that the service will return
NextToken
values as needed. For example, let's say you make
a request with MaxResults
set to 10, and there are 20
matches in the database. The service will return a pagination token as a
part of the response. This token can be used to call the API again and
get results starting from the 11th match.
Constraints:
Length: 1 -
Pattern: [\S]+
A pagination token. The first call you make will have
NextToken
set to null. After that the service will
return NextToken
values as needed. For example,
let's say you make a request with MaxResults
set to
10, and there are 20 matches in the database. The service will
return a pagination token as a part of the response. This token
can be used to call the API again and get results starting from
the 11th match.
public void setNextToken(String nextToken)
A pagination token. The first call you make will have
NextToken
set to null. After that the service will return
NextToken
values as needed. For example, let's say you make
a request with MaxResults
set to 10, and there are 20
matches in the database. The service will return a pagination token as a
part of the response. This token can be used to call the API again and
get results starting from the 11th match.
Constraints:
Length: 1 -
Pattern: [\S]+
nextToken
-
A pagination token. The first call you make will have
NextToken
set to null. After that the service
will return NextToken
values as needed. For
example, let's say you make a request with
MaxResults
set to 10, and there are 20 matches in
the database. The service will return a pagination token as a
part of the response. This token can be used to call the API
again and get results starting from the 11th match.
public LookupDeveloperIdentityRequest withNextToken(String nextToken)
A pagination token. The first call you make will have
NextToken
set to null. After that the service will return
NextToken
values as needed. For example, let's say you make
a request with MaxResults
set to 10, and there are 20
matches in the database. The service will return a pagination token as a
part of the response. This token can be used to call the API again and
get results starting from the 11th match.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 -
Pattern: [\S]+
nextToken
-
A pagination token. The first call you make will have
NextToken
set to null. After that the service
will return NextToken
values as needed. For
example, let's say you make a request with
MaxResults
set to 10, and there are 20 matches in
the database. The service will return a pagination token as a
part of the response. This token can be used to call the API
again and get results starting from the 11th match.
public String toString()
toString
in class Object
Object.toString()
Copyright © 2019. All rights reserved.