Class: SticapiClient::AD::User
- Inherits:
- 
      Object
      
        - Object
- SticapiClient::AD::User
 
- Defined in:
- lib/sticapi_client/user.rb
Class Method Summary collapse
- 
  
    
      .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 }. 
- 
  
    
      .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 }. 
- 
  
    
      .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 }. 
- 
  
    
      .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_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 | 
.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 }
| 87 88 89 | # File 'lib/sticapi_client/user.rb', line 87 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 }
| 78 79 80 | # File 'lib/sticapi_client/user.rb', line 78 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 }
| 60 61 62 | # File 'lib/sticapi_client/user.rb', line 60 def self.move_user( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/move_user", ) 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 }
| 69 70 71 | # File 'lib/sticapi_client/user.rb', line 69 def self.rename_user( = {}) Sticapi::SticapiClient.instance.sticapi_request("/users/rename_user", ) 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 |