Histórico da Página
Índice
| Índice | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Visão Geral
...
A documentação a seguir fornece uma introdução as APIs REST V2 do Identity. As APIs REST V2 seguem o padrão de autenticação servidor a servidor OAuth2.0 utilizando JWT.
Models
...
Esta página contém uma lista de todos os Models utilizados pelas APIs REST Identity. Os valores mostrados para cada campo são valores padrões.
UserAccountDTO
Informações pessoais de um usuário, independente da natureza multicontexto da conta.
| Bloco de código | ||
|---|---|---|
| ||
{
"id": "",
"firstName": "",
"lastName": "",
"password": "",
"address": "",
"phoneNumber": "",
"emailAddress": "",
"dateCreated": "Jan 14, 2014 11:47:03 AM",
"otpPin": "",
"role": "USER",
"verifiedEmails": {},
"companyIds": [],
"companyAccounts": [],
"appStateChanged": false,
"connectedToLinkedIn": false,
"connectedToFacebook": false,
"facebookId": "",
"linkedinId": "",
"userPhones": [],
"userEmails": [],
"tempPassword": "",
"passwordSet": false,
"loginMode": "PERSONAL",
"companyId": ""
} |
UserCompanyAccountDTO
Informações de um usuário dentro do contexto da empresa.
| Bloco de código |
|---|
{
"id": "",
"firstName": "",
"lastName": "",
"password": "",
"address": "",
"phoneNumber": "",
"emailAddress": "",
"isADImport": false,
"appStateChanged": false,
"adToken": "",
"jobTitle": "",
"dateCreated": "Jan 14, 2014 11:47:03 AM",
"companyName": "",
"role": "USER",
"userLoginType": "CP_LOGIN",
"userOrigin": "CP_ADMIN",
"assignedAppCount": 0,
"userStatus": "INVITED",
"previousUserStatus": "INVITED",
"resetKey": "",
"companyLogoPath": "",
"enableOTP": false,
"personalId": "",
"department": "",
"customFields": {},
"companyId": ""
} |
GroupDTO
Entidade que une usuários e aplicativos dentro de uma empresa.
| Bloco de código |
|---|
{
"itemName": "",
"description": "",
"userCount": 0,
"applicationCount": 0,
"companyId": ""
} |
CompanyDTO
Informações sobre a empresa.
| Bloco de código |
|---|
{
"itemName": "",
"dateCreated": "Jan 14, 2014 11:47:03 AM",
"tokenRequired": false,
"companyStatus": "CREATED",
"emailDomains": [],
"customLogo": false,
"selfSignUp": false,
"adLoginEnabled": false,
"adUserActivation": "ACTIVATION_BY_EMAIL",
"adPasswordChangeEnabled": false,
"userActivation": "EMAIL",
"displayAdPwdReqEnabled": false,
"adPwdRequirements": "",
"oauthClientId": "",
"companyId": "",
"loginWithoutEmailEnabled":false
}
|
CustomFieldDTO
Campos customizados de uma empresa.
| Bloco de código |
|---|
{
"name": "",
"label": "",
"value": "",
"length": "",
"type": "STRING",
"order": 2147483647,
"required": false,
"options": [],
"visibleToUsers": true,
"companyId": ""
} |
JwtClaimDTO
JWT Claim, necessário para OAuth 2.0.
| Bloco de código |
|---|
{
"iss": ""
} |
RefreshToken
Token retornado como resposta para OAuth.
| Bloco de código |
|---|
{
"refresh_token": "",
"access_token": "",
"client_id": "",
"timeIssuedInMillis": 0,
"expires_in": 3600
}
|
AccessToken
Token utilizado para chamadas REST.
| Bloco de código |
|---|
{
"access_token": "",
"client_id": "",
"timeIssuedInMillis": 0,
"expires_in": 0
}
|
Application
Informação sobre um determinado aplicativo.
| Bloco de código |
|---|
{ "appCategory": "",
"itemName": "",
"appDescription": "",
"extensionRev": 0.0,
"formAction": "",
"formId": "",
"formName": "",
"loginPageUrl": "",
"loginType": "FORM_LOGIN",
"passwordField": "",
"usernameField": "",
"passwordFieldIsId": false,
"usernameFieldIsId": false,
"thickAppName": "",
"submitPrefix": "",
"parentAppId": "",
"thickSSOProfile": "",
"domain": "",
"userLoginIdMapping": "USER_EMAIL",
"ssoInitType": "IDP_INITIATED",
"binding": "HTTP_REDIRECT",
"nameIdFormat": "EmailAddress",
"signed": true,
"encrypted": false,
"assertionUrl": "",
"recipient": "",
"audience": "",
"spIssuerName": "",
"provisionEnabled": false,
"entitlementEnabled": false,
"companySpecificIdSecret": false,
"provisionMode": "SCIM",
"provisionAuthType": "OAUTH2",
"provisionUsername": "",
"provisionPassword": "",
"provisionClientId": "",
"provisionClientSecret": "",
"provisionRestUrl": "",
"provisionAuthHeader": "",
"provisionAccessToken": "",
"provisionUserTempPassword": "",
"personal": false,
"browsable": false,
"isCustomApp": false,
"isCompanyApp": false,
"isGlobalApp": false,
"companyId": ""
} |
UserApplicationLoginDTO
Detalhes de um usuário para um determinado aplicativo dentro de uma empresa.
| Bloco de código |
|---|
{
"userId": "",
"appId": "",
"username": "",
"password": "",
"order": 2147483647,
"executablePath": "",
"isGroupAssociated": false,
"appUserId": "",
"companyId": ""
} |
UserLiteDTO
Versão simplificada de UserCompanyAccountDTO para casos em que é necessário uma resposta em grandes quantidades, por exemplo, todos usuários de uma empresa.
| Bloco de código |
|---|
{
"id": "",
"firstName": "",
"lastName": "",
"role": "",
"userStatus": "",
"emailAddress": "",
"previousUserStatus": "",
"jobTitle": "",
"department": "",
"companyId": ""
} |
SearchResults
Resposta para consultas que geram listas como “GET em todos usuários de uma empresa”
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas