Module: Oktakit::Client::IdentityProviders

Included in:
Oktakit::Client
Defined in:
lib/oktakit/client/identity_providers.rb

Instance Method Summary collapse

Instance Method Details

#activate_identity_provider(id, options = {}) ⇒ Hash<Sawyer::Resource>

Activate Identity Provider

Examples:

Oktakit.activate_identity_provider('id')

See Also:



94
95
96
# File 'lib/oktakit/client/identity_providers.rb', line 94

def activate_identity_provider(id, options = {})
  post("/idps/#{id}/lifecycle/activate", options)
end

#add_identity_provider(options = {}) ⇒ Hash<Sawyer::Resource>

Add Identity Provider

Examples:

Oktakit.add_identity_provider

See Also:



15
16
17
# File 'lib/oktakit/client/identity_providers.rb', line 15

def add_identity_provider(options = {})
  post('/idps', options)
end

#add_x509_certificate_public_key(options = {}) ⇒ Hash<Sawyer::Resource>

Add X.509 Certificate Public Key

Examples:

Oktakit.add_x509_certificate_public_key

See Also:



222
223
224
# File 'lib/oktakit/client/identity_providers.rb', line 222

def add_x509_certificate_public_key(options = {})
  post('/idps/credentials/keys', options)
end

#deactivate_identity_provider(id, options = {}) ⇒ Hash<Sawyer::Resource>

Deactivate Identity Provider

Examples:

Oktakit.deactivate_identity_provider('id')

See Also:



110
111
112
# File 'lib/oktakit/client/identity_providers.rb', line 110

def deactivate_identity_provider(id, options = {})
  post("/idps/#{id}/lifecycle/deactivate", options)
end

#delete_identity_provider(id, options = {}) ⇒ Object

Delete Identity Provider

Examples:

Oktakit.delete_identity_provider('id')

See Also:



78
79
80
# File 'lib/oktakit/client/identity_providers.rb', line 78

def delete_identity_provider(id, options = {})
  delete("/idps/#{id}", options)
end

#delete_key(key_id, options = {}) ⇒ Object

Delete Key

Examples:

Oktakit.delete_key('key_id')

See Also:



269
270
271
# File 'lib/oktakit/client/identity_providers.rb', line 269

def delete_key(key_id, options = {})
  delete("/idps/credentials/keys/#{key_id}", options)
end

#get_identity_provider(id, options = {}) ⇒ Hash<Sawyer::Resource>

Get Identity Provider

Examples:

Oktakit.get_identity_provider('id')

See Also:



31
32
33
# File 'lib/oktakit/client/identity_providers.rb', line 31

def get_identity_provider(id, options = {})
  get("/idps/#{id}", options)
end

#get_identity_provider_transaction(transaction_id, options = {}) ⇒ Hash<Sawyer::Resource>

Get Identity Provider Transaction

Examples:

Oktakit.get_identity_provider_transaction('transaction_id')

See Also:



126
127
128
# File 'lib/oktakit/client/identity_providers.rb', line 126

def get_identity_provider_transaction(transaction_id, options = {})
  get("/idps/tx/#{transaction_id}", options)
end

#get_key(key_id, options = {}) ⇒ Hash<Sawyer::Resource>

Get Key

Examples:

Oktakit.get_key('key_id')

See Also:



238
239
240
# File 'lib/oktakit/client/identity_providers.rb', line 238

def get_key(key_id, options = {})
  get("/idps/credentials/keys/#{key_id}", options)
end

#get_source_idp_user_for_idp_transaction(transaction_id, options = {}) ⇒ Hash<Sawyer::Resource>

Get Source IdP User for IdP Transaction

Examples:

Oktakit.get_source_idp_user_for_idp_transaction('transaction_id')

See Also:



142
143
144
# File 'lib/oktakit/client/identity_providers.rb', line 142

def get_source_idp_user_for_idp_transaction(transaction_id, options = {})
  get("/idps/tx/#{transaction_id}/source", options)
end

#get_target_user_for_idp_provision_transaction(transaction_id, options = {}) ⇒ Hash<Sawyer::Resource>

Get Target User for IdP Provision Transaction

Examples:

Oktakit.get_target_user_for_idp_provision_transaction('transaction_id')

See Also:



158
159
160
# File 'lib/oktakit/client/identity_providers.rb', line 158

def get_target_user_for_idp_provision_transaction(transaction_id, options = {})
  get("/idps/tx/#{transaction_id}/target", options)
end

Link IdP User

Examples:

Oktakit.link_idp_user('user_id', 'transaction_id')

See Also:



207
208
209
# File 'lib/oktakit/client/identity_providers.rb', line 207

def link_idp_user(transaction_id, user_id, options = {})
  post("/idps/tx/#{transaction_id}/lifecycle/confirm/#{user_id}", options)
end

#list_identity_providers(options = {}) ⇒ Array<Sawyer::Resource>

List Identity Providers

Examples:

Oktakit.list_identity_providers

See Also:



46
47
48
# File 'lib/oktakit/client/identity_providers.rb', line 46

def list_identity_providers(options = {})
  get('/idps', options)
end

#list_keys(options = {}) ⇒ Array<Sawyer::Resource>

List Keys



253
254
255
# File 'lib/oktakit/client/identity_providers.rb', line 253

def list_keys(options = {})
  get('/idps/credentials/keys', options)
end

List Users for IdP Link Transaction

Examples:

Oktakit.list_users_for_idp_link_transaction('transaction_id')

See Also:



174
175
176
# File 'lib/oktakit/client/identity_providers.rb', line 174

def list_users_for_idp_link_transaction(transaction_id, options = {})
  get("/idps/tx/#{transaction_id}/users", options)
end

#provision_idp_user(transaction_id, options = {}) ⇒ Hash<Sawyer::Resource>

Provision IdP User

Examples:

Oktakit.provision_idp_user('transaction_id')

See Also:



190
191
192
# File 'lib/oktakit/client/identity_providers.rb', line 190

def provision_idp_user(transaction_id, options = {})
  post("/idps/tx/#{transaction_id}/lifecycle/provision", options)
end

#update_identity_provider(id, options = {}) ⇒ Hash<Sawyer::Resource>

Update Identity Provider

Examples:

Oktakit.update_identity_provider('id')

See Also:



62
63
64
# File 'lib/oktakit/client/identity_providers.rb', line 62

def update_identity_provider(id, options = {})
  put("/idps/#{id}", options)
end