Class: SticapiClient::AD::User
- Inherits:
-
Object
- Object
- SticapiClient::AD::User
- Defined in:
- lib/sticapi_client/user.rb
Class Method Summary collapse
-
.add_E1_license(options = {}) ⇒ Object
Adiciona licença E1 de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao adicionar grupo do usuário user: { string }.
-
.add_E1_sem_teams_license(options = {}) ⇒ Object
Adiciona licença E1 sem teams de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao adicionar grupo do usuário user: { string }.
-
.add_E3_license(options = {}) ⇒ Object
Adiciona licença E3 de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao adicionar grupo do usuário user: { string }.
-
.add_E3_sem_teams_license(options = {}) ⇒ Object
Adiciona licença E3 sem teams de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao adicionar grupo do usuário user: { string }.
-
.add_E5_license(options = {}) ⇒ Object
Adiciona licença E5 de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao adicionar grupo do usuário user: { string }.
-
.add_E5_sem_teams_license(options = {}) ⇒ Object
Adiciona licença E5 sem teams de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao adicionar grupo do usuário user: { string }.
-
.add_institutional_email(options = {}) ⇒ Object
Adiciona o email institucional a um usuário no AD Parâmetro username [string] username Parâmetro email [String] novo email do usuário Retorno [JSON] Sucesso ou falha ao alterar o email do usuário user: { string }.
-
.add_mail_license(options = {}) ⇒ Object
Remove licença de email de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao remover grupo do usuário user: { string }.
-
.add_teams_license(options = {}) ⇒ Object
Remove licença teams de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao remover grupo do usuário user: { string }.
-
.add_user(options = {}) ⇒ Object
Cadastra um usuário no AD Parâmetro attrs [json] { cn, description, displayName, street, title, physicaldeliveryofficename, telephonenumber } Parâmetro pwd [String] senha do usuário Parâmetro ou [String] unidade organizacional do usuário Retorno [JSON] Sucesso ou falha ao cadastrar o usuário user: { string }.
-
.block_user_ad(options = {}) ⇒ Object
Bloqueia o usuário no AD Parâmetro value [String] username Retorno [JSON] Sucesso ou falha ao bloqueiar o usuário user: { string }.
-
.change_password(options = {}) ⇒ Object
Altera a senha de um usuário no AD Parâmetro username [string] username Parâmetro newpwd [String] nova senha do usuário Retorno [JSON] Sucesso ou falha ao alterar a senha do usuário user: { string }.
-
.change_user(options = {}) ⇒ Object
Altera as informações do um usuário no AD Parâmetro username [string] username Parâmetro attrs [json] { email, description, displayName, street, title, physicaldeliveryofficename, telephonenumber } Retorno [JSON] Sucesso ou falha ao alterar os dados do usuário user: { string }.
-
.disable_user(options = {}) ⇒ Object
Desabilita o usuário no AD Parâmetro value [String] username Retorno [JSON] Sucesso ou falha ao desabilitar o usuário user: { string }.
-
.enable_user(options = {}) ⇒ Object
Habilita o usuário no AD Parâmetro value [String] username Retorno [JSON] Sucesso ou falha ao habilitar o usuário user: { string }.
-
.find_user(options = {}) ⇒ Object
Consulta dados do usuário no AD Parâmetro filter [String] cn, samaccountname, description, userprincipalname Parâmetro value [String] username (caso filter seja cn ou samaccountname), cpf (caso filter seja description), email (caso filter seja userprincipalname) Retorno [JSON] Dados básicos da pessoa user: { dn username samaccountname address cpf email name memberof[] job_title function department unit_phone useraccountcontrol }.
-
.list_all ⇒ Object
Consulta todos os usuários no AD Retorno [JSON] todos os usuários no AD campos: [ usuários ].
-
.move_user(options = {}) ⇒ Object
Altera a unidade organizacional de um usuário no AD Parâmetro username [string] username Parâmetro base [String] “OU=PJPI.OFF,OU=intranet,DC=tjpi,DC=local” Retorno [JSON] Sucesso ou falha ao mover o usuário user: { string }.
-
.remove_E1_license(options = {}) ⇒ Object
Remove licença E1 de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao remover grupo do usuário user: { string }.
-
.remove_E1_sem_teams_license(options = {}) ⇒ Object
Remove licença E1 sem teams de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao remover grupo do usuário user: { string }.
-
.remove_E3_license(options = {}) ⇒ Object
Remove licença E3 de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao remover grupo do usuário user: { string }.
-
.remove_E3_sem_teams_license(options = {}) ⇒ Object
Remove licença E3 sem teams de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao remover grupo do usuário user: { string }.
-
.remove_E5_license(options = {}) ⇒ Object
Remove licença E5 de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao remover grupo do usuário user: { string }.
-
.remove_E5_sem_teams_license(options = {}) ⇒ Object
Remove licença E5 sem teams de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao remover grupo do usuário user: { string }.
-
.remove_mail_license(options = {}) ⇒ Object
Remove licença de email de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao remover grupo do usuário user: { string }.
-
.remove_teams_license(options = {}) ⇒ Object
Remove licença teams de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao remover grupo do usuário user: { string }.
-
.rename_user(options = {}) ⇒ Object
Altera o nome de um usuário no AD Parâmetro username [string] username Parâmetro value [String] novo nome do usuário Retorno [JSON] Sucesso ou falha ao renomear o usuário user: { string }.
-
.unblock_user_ad(options = {}) ⇒ Object
Desbloqueia o usuário no AD Parâmetro value [String] username Retorno [JSON] Sucesso ou falha ao desbloqueiar o usuário user: { string }.
-
.user_units(options = {}) ⇒ Object
Consulta as unidades do usuário no SEI Parâmetro username [String] nome do usuário Retorno [JSON] unidades do usuário no SEI campos: [ id_unidade id_orgao sigla descricao sin_ativo sin_global name id_origem ].
Class Method Details
.add_E1_license(options = {}) ⇒ Object
Adiciona licença E1 de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao adicionar grupo do usuário
user: { string }
120 121 122 |
# File 'lib/sticapi_client/user.rb', line 120 def self.add_E1_license( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/add_E1_license", ) end |
.add_E1_sem_teams_license(options = {}) ⇒ Object
Adiciona licença E1 sem teams de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao adicionar grupo do usuário
user: { string }
128 129 130 |
# File 'lib/sticapi_client/user.rb', line 128 def self.add_E1_sem_teams_license( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/add_E1_sem_teams_license", ) end |
.add_E3_license(options = {}) ⇒ Object
Adiciona licença E3 de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao adicionar grupo do usuário
user: { string }
152 153 154 |
# File 'lib/sticapi_client/user.rb', line 152 def self.add_E3_license( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/add_E3_license", ) end |
.add_E3_sem_teams_license(options = {}) ⇒ Object
Adiciona licença E3 sem teams de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao adicionar grupo do usuário
user: { string }
160 161 162 |
# File 'lib/sticapi_client/user.rb', line 160 def self.add_E3_sem_teams_license( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/add_E3_sem_teams_license", ) end |
.add_E5_license(options = {}) ⇒ Object
Adiciona licença E5 de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao adicionar grupo do usuário
user: { string }
184 185 186 |
# File 'lib/sticapi_client/user.rb', line 184 def self.add_E5_license( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/add_E5_license", ) end |
.add_E5_sem_teams_license(options = {}) ⇒ Object
Adiciona licença E5 sem teams de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao adicionar grupo do usuário
user: { string }
192 193 194 |
# File 'lib/sticapi_client/user.rb', line 192 def self.add_E5_sem_teams_license( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/add_E5_sem_teams_license", ) end |
.add_institutional_email(options = {}) ⇒ Object
Adiciona o email institucional a um usuário no AD Parâmetro username [string] username Parâmetro email [String] novo email do usuário Retorno [JSON] Sucesso ou falha ao alterar o email do usuário
user: { string }
112 113 114 |
# File 'lib/sticapi_client/user.rb', line 112 def self.add_institutional_email( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/add_institutional_email", ) end |
.add_mail_license(options = {}) ⇒ Object
Remove licença de email de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao remover grupo do usuário
user: { string }
232 233 234 |
# File 'lib/sticapi_client/user.rb', line 232 def self.add_mail_license( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/add_mail_license", ) end |
.add_teams_license(options = {}) ⇒ Object
Remove licença teams de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao remover grupo do usuário
user: { string }
216 217 218 |
# File 'lib/sticapi_client/user.rb', line 216 def self.add_teams_license( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/add_teams_license", ) end |
.add_user(options = {}) ⇒ Object
Cadastra um usuário no AD Parâmetro attrs [json] { cn, description, displayName, street, title, physicaldeliveryofficename, telephonenumber } Parâmetro pwd [String] senha do usuário Parâmetro ou [String] unidade organizacional do usuário Retorno [JSON] Sucesso ou falha ao cadastrar o usuário
user: { string }
28 29 30 |
# File 'lib/sticapi_client/user.rb', line 28 def self.add_user( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/add_user", ) end |
.block_user_ad(options = {}) ⇒ Object
Bloqueia o usuário no AD Parâmetro value [String] username Retorno [JSON] Sucesso ou falha ao bloqueiar o usuário
user: { string }
59 60 61 |
# File 'lib/sticapi_client/user.rb', line 59 def self.block_user_ad( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/block_user_ad", ) end |
.change_password(options = {}) ⇒ Object
Altera a senha de um usuário no AD Parâmetro username [string] username Parâmetro newpwd [String] nova senha do usuário Retorno [JSON] Sucesso ou falha ao alterar a senha do usuário
user: { string }
103 104 105 |
# File 'lib/sticapi_client/user.rb', line 103 def self.change_password( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/change_password", ) end |
.change_user(options = {}) ⇒ Object
Altera as informações do um usuário no AD Parâmetro username [string] username Parâmetro attrs [json] { email, description, displayName, street, title, physicaldeliveryofficename, telephonenumber } Retorno [JSON] Sucesso ou falha ao alterar os dados do usuário
user: { string }
94 95 96 |
# File 'lib/sticapi_client/user.rb', line 94 def self.change_user( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/change_user", ) end |
.disable_user(options = {}) ⇒ Object
Desabilita o usuário no AD Parâmetro value [String] username Retorno [JSON] Sucesso ou falha ao desabilitar o usuário
user: { string }
51 52 53 |
# File 'lib/sticapi_client/user.rb', line 51 def self.disable_user( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/disable_user", ) end |
.enable_user(options = {}) ⇒ Object
Habilita o usuário no AD Parâmetro value [String] username Retorno [JSON] Sucesso ou falha ao habilitar o usuário
user: { string }
43 44 45 |
# File 'lib/sticapi_client/user.rb', line 43 def self.enable_user( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/enable_user", ) end |
.find_user(options = {}) ⇒ Object
Consulta dados do usuário no AD Parâmetro filter [String] cn, samaccountname, description, userprincipalname Parâmetro value [String] username (caso filter seja cn ou samaccountname), cpf (caso filter seja description), email (caso filter seja userprincipalname) Retorno [JSON] Dados básicos da pessoa
user: { dn username samaccountname address cpf email name memberof[] job_title function department unit_phone useraccountcontrol }
9 10 11 |
# File 'lib/sticapi_client/user.rb', line 9 def self.find_user( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/find_user", ) end |
.list_all ⇒ Object
Consulta todos os usuários no AD Retorno [JSON] todos os usuários no AD
campos: [ usuários ]
35 36 37 |
# File 'lib/sticapi_client/user.rb', line 35 def self.list_all Sticapi::SticapiClient.instance.sticapi_request("/users/list_all") end |
.move_user(options = {}) ⇒ Object
Altera a unidade organizacional de um usuário no AD Parâmetro username [string] username Parâmetro base [String] “OU=PJPI.OFF,OU=intranet,DC=tjpi,DC=local” Retorno [JSON] Sucesso ou falha ao mover o usuário
user: { string }
76 77 78 |
# File 'lib/sticapi_client/user.rb', line 76 def self.move_user( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/move_user", ) end |
.remove_E1_license(options = {}) ⇒ Object
Remove licença E1 de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao remover grupo do usuário
user: { string }
136 137 138 |
# File 'lib/sticapi_client/user.rb', line 136 def self.remove_E1_license( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/remove_E1_license", ) end |
.remove_E1_sem_teams_license(options = {}) ⇒ Object
Remove licença E1 sem teams de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao remover grupo do usuário
user: { string }
144 145 146 |
# File 'lib/sticapi_client/user.rb', line 144 def self.remove_E1_sem_teams_license( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/remove_E1_sem_teams_license", ) end |
.remove_E3_license(options = {}) ⇒ Object
Remove licença E3 de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao remover grupo do usuário
user: { string }
168 169 170 |
# File 'lib/sticapi_client/user.rb', line 168 def self.remove_E3_license( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/remove_E3_license", ) end |
.remove_E3_sem_teams_license(options = {}) ⇒ Object
Remove licença E3 sem teams de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao remover grupo do usuário
user: { string }
176 177 178 |
# File 'lib/sticapi_client/user.rb', line 176 def self.remove_E3_sem_teams_license( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/remove_E3_sem_teams_license", ) end |
.remove_E5_license(options = {}) ⇒ Object
Remove licença E5 de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao remover grupo do usuário
user: { string }
200 201 202 |
# File 'lib/sticapi_client/user.rb', line 200 def self.remove_E5_license( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/remove_E5_license", ) end |
.remove_E5_sem_teams_license(options = {}) ⇒ Object
Remove licença E5 sem teams de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao remover grupo do usuário
user: { string }
208 209 210 |
# File 'lib/sticapi_client/user.rb', line 208 def self.remove_E5_sem_teams_license( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/remove_E5_sem_teams_license", ) end |
.remove_mail_license(options = {}) ⇒ Object
Remove licença de email de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao remover grupo do usuário
user: { string }
240 241 242 |
# File 'lib/sticapi_client/user.rb', line 240 def self.remove_mail_license( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/remove_mail_license", ) end |
.remove_teams_license(options = {}) ⇒ Object
Remove licença teams de um usuário no AD Parâmetro username [string] username Retorno [JSON] Sucesso ou falha ao remover grupo do usuário
user: { string }
224 225 226 |
# File 'lib/sticapi_client/user.rb', line 224 def self.remove_teams_license( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/remove_teams_license", ) end |
.rename_user(options = {}) ⇒ Object
Altera o nome de um usuário no AD Parâmetro username [string] username Parâmetro value [String] novo nome do usuário Retorno [JSON] Sucesso ou falha ao renomear o usuário
user: { string }
85 86 87 |
# File 'lib/sticapi_client/user.rb', line 85 def self.rename_user( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/rename_user", ) end |
.unblock_user_ad(options = {}) ⇒ Object
Desbloqueia o usuário no AD Parâmetro value [String] username Retorno [JSON] Sucesso ou falha ao desbloqueiar o usuário
user: { string }
67 68 69 |
# File 'lib/sticapi_client/user.rb', line 67 def self.unblock_user_ad( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/unblock_user_ad", ) end |
.user_units(options = {}) ⇒ Object
Consulta as unidades do usuário no SEI Parâmetro username [String] nome do usuário Retorno [JSON] unidades do usuário no SEI
campos: [ id_unidade id_orgao sigla descricao sin_ativo sin_global name id_origem ]
17 18 19 20 |
# File 'lib/sticapi_client/user.rb', line 17 def self.user_units( = {}) [:kind] = "get" Sticapi::SticapiClient.instance.sticapi_request("/users/unidades_do_usuario", ) end |