module Oktakit::Client::IdentityProviders

Public Instance Methods

activate_identity_provider(id, options = {}) click to toggle source

Activate Identity Provider

@params id [string] IDPS ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Activated Identity Provider @see developer.okta.com/docs/api/resources/idps.html#activate-identity-provider @example

Oktakit.activate_identity_provider('id')
# 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 = {}) click to toggle source

Add Identity Provider

@param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] The created Identity Provider @see developer.okta.com/docs/api/resources/idps.html#add-identity-provider @example

Oktakit.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 = {}) click to toggle source

Add X.509 Certificate Public Key

@param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Identity Provider Key Credential @see developer.okta.com/docs/api/resources/idps.html#add-x509-certificate-public-key @example

Oktakit.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 = {}) click to toggle source

Deactivate Identity Provider

@params id [string] IDPS ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Deactivated Identity Provider @see developer.okta.com/docs/api/resources/idps.html#deactivate-identity-provider @example

Oktakit.deactivate_identity_provider('id')
# 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 = {}) click to toggle source

Delete Identity Provider

@params id [string] IDPS ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return HTTP 204 No Content @see developer.okta.com/docs/api/resources/idps.html#delete-identity-provider @example

Oktakit.delete_identity_provider('id')
# 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 = {}) click to toggle source

Delete Key

@params key_id [string] Key ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return HTTP 204 No Content @see developer.okta.com/docs/api/resources/idps.html#delete-key @example

Oktakit.delete_key('key_id')
# 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 = {}) click to toggle source

Get Identity Provider

@params id [string] IDPS ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Identity Provider @see developer.okta.com/docs/api/resources/idps.html#get-identity-provider @example

Oktakit.get_identity_provider('id')
# 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 = {}) click to toggle source

Get Identity Provider Transaction

@params transaction_id [string] Transaction ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Identity Provider Transaction @see developer.okta.com/docs/api/resources/idps.html#get-identity-provider-transaction @example

Oktakit.get_identity_provider_transaction('transaction_id')
# 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 = {}) click to toggle source

Get Key

@params key_id [string] Key ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Identity Provider Key Credential @see developer.okta.com/docs/api/resources/idps.html#get-key @example

Oktakit.get_key('key_id')
# 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 = {}) click to toggle source

Get Source IdP User for IdP Transaction

@params transaction_id [string] Transaction ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Identity Provider User @see developer.okta.com/docs/api/resources/idps.html#get-source-idp-user-for-idp-transaction @example

Oktakit.get_source_idp_user_for_idp_transaction('transaction_id')
# 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 = {}) click to toggle source

Get Target User for IdP Provision Transaction

@params transaction_id [string] Transaction ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Trasformed Okta User Profile @see developer.okta.com/docs/api/resources/idps.html#get-target-user-for-idp-provision-transaction @example

Oktakit.get_target_user_for_idp_provision_transaction('transaction_id')
# 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
list_identity_providers(options = {}) click to toggle source

List Identity Providers

@param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Array<Sawyer::Resource>] Array of Identity Provider @see developer.okta.com/docs/api/resources/idps.html#list-identity-providers @example

Oktakit.list_identity_providers
# File lib/oktakit/client/identity_providers.rb, line 46
def list_identity_providers(options = {})
  get('/idps', options)
end
list_keys(options = {}) click to toggle source

List Keys

@param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Array<Sawyer::Resource>] Array of Identity Provider Key Credential @see developer.okta.com/docs/api/resources/idps.html#list-keys @example

Oktakit.list_keys
# File lib/oktakit/client/identity_providers.rb, line 253
def list_keys(options = {})
  get('/idps/credentials/keys', options)
end
provision_idp_user(transaction_id, options = {}) click to toggle source

Provision IdP User

@params transaction_id [string] Transaction ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Identity Provider Transaction @see developer.okta.com/docs/api/resources/idps.html#provision-idp-user @example

Oktakit.provision_idp_user('transaction_id')
# 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 = {}) click to toggle source

Update Identity Provider

@params id [string] IDPS ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Updated Identity Provider @see developer.okta.com/docs/api/resources/idps.html#update-identity-provider @example

Oktakit.update_identity_provider('id')
# File lib/oktakit/client/identity_providers.rb, line 62
def update_identity_provider(id, options = {})
  put("/idps/#{id}", options)
end