| Índice | ||||||||
|---|---|---|---|---|---|---|---|---|
|
A documentação a seguir fornece uma introdução as APIs REST V2 do Fluig Identity. As APIs REST V2 seguem o padrão de autenticação servidor a servidor OAuth2.0 utilizando JWT.
...
| 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": ""
} |
...
...
Informações de um usuário dentro do contexto da 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": ""
}
|
...
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 OAuth2.0
...
| Bloco de código |
|---|
{{ "iss": |
...
"" |
...
} |
...
RefreshToken: token Token retornado como resposta para OAuth.OAuth
...
| Bloco de código |
|---|
{{ "refresh_token": |
...
"", |
...
"access_token": |
...
"", |
...
"client_id": |
...
"", |
...
"timeIssuedInMillis": 0, |
...
"expires_in": 3600 |
...
} |
...
AccessToken: token Token utilizado para chamadas REST 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: Informações Informações sobre 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”
...
| Bloco de código |
|---|
{ |
...
"count": 0, |
...
// Número total de resultados |
...
retornados "list": [], |
...
//Lista de models, por ex: lista de UserLiteDTO no caso de pegar todos os usuários na empresa |
...
"totalCount": 0, |
...
// Número total de resultados baseados no critério |
...
"offset": 0, |
...
//Offset da página requisitado pelo cliente |
...
"pageSize": |
...
0 //Tamanho da página requisitado pelo cliente } |
}