Module: Oktakit::Client::IdentityProviders

Included in:

Oktakit::Client

Defined in:

lib/oktakit/client/identity_providers.rb

Instance Method Summary

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

  Activate Identity Provider.

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

  Add Identity Provider.

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

  Add X.509 Certificate Public Key.

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

  Deactivate Identity Provider.

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

  Delete Identity Provider.

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

  Delete Key.

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

  Get Identity Provider.

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

  Get Identity Provider Transaction.

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

  Get Key.

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

  Get Source IdP User for IdP Transaction.

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

  Get Target User for IdP Provision Transaction.

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

  Link IdP User.

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

  List Identity Providers.

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

  List Keys.

• #list_users_for_idp_link_transaction(transaction_id, options = {}) ⇒ Array<Sawyer::Resource>

  List Users for IdP Link Transaction.

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

  Provision IdP User.

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

  Update Identity Provider.

Instance Method Details

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

Activate Identity Provider

Examples:

Oktakit.activate_identity_provider('id')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Hash<Sawyer::Resource>) —

  Activated Identity Provider

See Also:

• http://developer.okta.com/docs/api/resources/idps.html#activate-identity-provider

# 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

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Hash<Sawyer::Resource>) —

  The created Identity Provider

See Also:

• http://developer.okta.com/docs/api/resources/idps.html#add-identity-provider

# 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

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Hash<Sawyer::Resource>) —

  Identity Provider Key Credential

See Also:

• http://developer.okta.com/docs/api/resources/idps.html#add-x509-certificate-public-key

# 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')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Hash<Sawyer::Resource>) —

  Deactivated Identity Provider

See Also:

• http://developer.okta.com/docs/api/resources/idps.html#deactivate-identity-provider

# 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')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• HTTP 204 No Content

See Also:

• http://developer.okta.com/docs/api/resources/idps.html#delete-identity-provider

# 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')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• HTTP 204 No Content

See Also:

• http://developer.okta.com/docs/api/resources/idps.html#delete-key

# 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')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Hash<Sawyer::Resource>) —

  Identity Provider

See Also:

• http://developer.okta.com/docs/api/resources/idps.html#get-identity-provider

# 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')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Hash<Sawyer::Resource>) —

  Identity Provider Transaction

See Also:

• http://developer.okta.com/docs/api/resources/idps.html#get-identity-provider-transaction

# 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')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Hash<Sawyer::Resource>) —

  Identity Provider Key Credential

See Also:

• http://developer.okta.com/docs/api/resources/idps.html#get-key

# 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')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Hash<Sawyer::Resource>) —

  Identity Provider User

See Also:

• http://developer.okta.com/docs/api/resources/idps.html#get-source-idp-user-for-idp-transaction

# 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')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Hash<Sawyer::Resource>) —

  Trasformed Okta User Profile

See Also:

• http://developer.okta.com/docs/api/resources/idps.html#get-target-user-for-idp-provision-transaction

# 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(transaction_id, user_id, options = {}) ⇒ Hash<Sawyer::Resource>

Link IdP User

Examples:

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

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Hash<Sawyer::Resource>) —

  Identity Provider Transaction

See Also:

• http://developer.okta.com/docs/api/resources/idps.html#link-idp-user

# 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

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Array<Sawyer::Resource>) —

  Array of Identity Provider

See Also:

• http://developer.okta.com/docs/api/resources/idps.html#list-identity-providers

# 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

Examples:

Oktakit.list_keys

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Array<Sawyer::Resource>) —

  Array of Identity Provider Key Credential

See Also:

• http://developer.okta.com/docs/api/resources/idps.html#list-keys

# 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(transaction_id, options = {}) ⇒ Array<Sawyer::Resource>

List Users for IdP Link Transaction

Examples:

Oktakit.list_users_for_idp_link_transaction('transaction_id')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Array<Sawyer::Resource>) —

  Array of Okta User

See Also:

• http://developer.okta.com/docs/api/resources/idps.html#list-users-for-idp-link-transaction

# 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')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Hash<Sawyer::Resource>) —

  Identity Provider Transaction

See Also:

• http://developer.okta.com/docs/api/resources/idps.html#provision-idp-user

# 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')

Parameters:

• options (:query) (defaults to: {}) —

  Hash

  Optional. Query params for request

• options (:headers) (defaults to: {}) —

  Hash

  Optional. Header params for the request.

• options (:accept) (defaults to: {}) —

  String

  Optional. The content type to accept. Default application/json

• options (:content_type) (defaults to: {}) —

  String

  Optional. The content type for the request. Default application/json

• options (Hash) (defaults to: {}) —

  Optional. Body params for request.

Returns:

• (Hash<Sawyer::Resource>) —

  Updated Identity Provider

See Also:

• http://developer.okta.com/docs/api/resources/idps.html#update-identity-provider

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

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