Module: Oktakit::Client::Schemas

Included in:

Oktakit::Client

Defined in:

lib/oktakit/client/schemas.rb

Instance Method Summary

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

  Add Property to App User Profile Schema.

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

  Add Property to User Profile Schema.

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

  Get App User Schema.

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

  Get User Schema.

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

  Remove property from App User Profile Schema.

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

  Remove Property from User Profile Schema.

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

  Update App User Profile Schema property.

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

  Update User Profile Schema Property.

Instance Method Details

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

Add Property to App User Profile Schema

Examples:

Oktakit.add_property_to_app_user_profile_schema('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>) —

  User Schema

See Also:

• https://developer.okta.com/docs/reference/api/schemas/#add-property-to-app-user-profile-schema

# File 'lib/oktakit/client/schemas.rb', line 92

def add_property_to_app_user_profile_schema(id, options = {})
  post("/meta/schemas/apps/#{id}/default", options)
end

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

Add Property to User Profile Schema

Examples:

Oktakit.add_property_to_user_profile_schema

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>) —

  User Schema

See Also:

• http://developer.okta.com/docs/api/resources/schemas.html#add-property-to-user-profile-schema

# File 'lib/oktakit/client/schemas.rb', line 30

def add_property_to_user_profile_schema(options = {})
  post('/meta/schemas/user/default', options)
end

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

Get App User Schema

Examples:

Oktakit.get_app_user_schema('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>) —

  User Schema

See Also:

• https://developer.okta.com/docs/reference/api/schemas/#get-app-user-schema

# File 'lib/oktakit/client/schemas.rb', line 76

def get_app_user_schema(id, options = {})
  get("/meta/schemas/apps/#{id}/default", options)
end

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

Get User Schema

Examples:

Oktakit.get_user_schema

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>) —

  User Schema

See Also:

• http://developer.okta.com/docs/api/resources/schemas.html#get-user-schema

# File 'lib/oktakit/client/schemas.rb', line 15

def get_user_schema(options = {})
  get('/meta/schemas/user/default', options)
end

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

Remove property from App User Profile Schema

Examples:

Oktakit.remove_property_from_app_user_profile_schema('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>) —

  User Schema

See Also:

• https://developer.okta.com/docs/reference/api/schemas/#remove-property-from-app-user-profile-schema

# File 'lib/oktakit/client/schemas.rb', line 124

def remove_property_from_app_user_profile_schema(id, options = {})
  post("/meta/schemas/apps/#{id}/default", options)
end

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

Remove Property from User Profile Schema

Examples:

Oktakit.remove_property_from_user_profile_schema

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>) —

  User Schema

See Also:

• http://developer.okta.com/docs/api/resources/schemas.html#remove-property-from-user-profile-schema

# File 'lib/oktakit/client/schemas.rb', line 60

def remove_property_from_user_profile_schema(options = {})
  post('/meta/schemas/user/default', options)
end

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

Update App User Profile Schema property

Examples:

Oktakit.update_app_user_profile_schema_property('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>) —

  User Schema

See Also:

• https://developer.okta.com/docs/reference/api/schemas/#update-app-user-profile-schema-property

# File 'lib/oktakit/client/schemas.rb', line 108

def update_app_user_profile_schema_property(id, options = {})
  post("/meta/schemas/apps/#{id}/default", options)
end

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

Update User Profile Schema Property

Examples:

Oktakit.update_user_profile_schema_property

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>) —

  User Schema

See Also:

• http://developer.okta.com/docs/api/resources/schemas.html#update-user-profile-schema-property

# File 'lib/oktakit/client/schemas.rb', line 45

def update_user_profile_schema_property(options = {})
  post('/meta/schemas/user/default', options)
end