\IdentityAttributesAPI

All URIs are relative to https://sailpoint.api.identitynow.com/beta

Method	HTTP request	Description
CreateIdentityAttribute	Post /identity-attributes	Create Identity Attribute
DeleteIdentityAttribute	Delete /identity-attributes/{name}	Delete Identity Attribute
DeleteIdentityAttributesInBulk	Post /identity-attributes/bulk-delete	Bulk delete Identity Attributes
GetIdentityAttribute	Get /identity-attributes/{name}	Get Identity Attribute
ListIdentityAttributes	Get /identity-attributes	List Identity Attributes
PutIdentityAttribute	Put /identity-attributes/{name}	Update Identity Attribute

CreateIdentityAttribute

IdentityAttribute CreateIdentityAttribute(ctx).IdentityAttribute(identityAttribute).Execute()

Create Identity Attribute

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/sailpoint-oss/golang-sdk/v2"
)

func main() {
    identityAttribute := *openapiclient.NewIdentityAttribute("uid") // IdentityAttribute | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.IdentityAttributesAPI.CreateIdentityAttribute(context.Background()).IdentityAttribute(identityAttribute).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IdentityAttributesAPI.CreateIdentityAttribute``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateIdentityAttribute`: IdentityAttribute
    fmt.Fprintf(os.Stdout, "Response from `IdentityAttributesAPI.CreateIdentityAttribute`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCreateIdentityAttributeRequest struct via the builder pattern

Name	Type	Description	Notes
identityAttribute	IdentityAttribute

Return type

IdentityAttribute

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteIdentityAttribute

DeleteIdentityAttribute(ctx, name).Execute()

Delete Identity Attribute

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/sailpoint-oss/golang-sdk/v2"
)

func main() {
    name := "displayName" // string | The attribute's technical name.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.IdentityAttributesAPI.DeleteIdentityAttribute(context.Background(), name).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IdentityAttributesAPI.DeleteIdentityAttribute``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
name	string	The attribute's technical name.

Other Parameters

Other parameters are passed through a pointer to a apiDeleteIdentityAttributeRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteIdentityAttributesInBulk

DeleteIdentityAttributesInBulk(ctx).IdentityAttributeNames(identityAttributeNames).Execute()

Bulk delete Identity Attributes

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/sailpoint-oss/golang-sdk/v2"
)

func main() {
    identityAttributeNames := *openapiclient.NewIdentityAttributeNames() // IdentityAttributeNames | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.IdentityAttributesAPI.DeleteIdentityAttributesInBulk(context.Background()).IdentityAttributeNames(identityAttributeNames).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IdentityAttributesAPI.DeleteIdentityAttributesInBulk``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiDeleteIdentityAttributesInBulkRequest struct via the builder pattern

Name	Type	Description	Notes
identityAttributeNames	IdentityAttributeNames

Return type

(empty response body)

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetIdentityAttribute

IdentityAttribute GetIdentityAttribute(ctx, name).Execute()

Get Identity Attribute

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/sailpoint-oss/golang-sdk/v2"
)

func main() {
    name := "displayName" // string | The attribute's technical name.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.IdentityAttributesAPI.GetIdentityAttribute(context.Background(), name).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IdentityAttributesAPI.GetIdentityAttribute``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetIdentityAttribute`: IdentityAttribute
    fmt.Fprintf(os.Stdout, "Response from `IdentityAttributesAPI.GetIdentityAttribute`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
name	string	The attribute's technical name.

Other Parameters

Other parameters are passed through a pointer to a apiGetIdentityAttributeRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

IdentityAttribute

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListIdentityAttributes

[]IdentityAttribute ListIdentityAttributes(ctx).IncludeSystem(includeSystem).IncludeSilent(includeSilent).SearchableOnly(searchableOnly).Count(count).Execute()

List Identity Attributes

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/sailpoint-oss/golang-sdk/v2"
)

func main() {
    includeSystem := false // bool | Include \"system\" attributes in the response. (optional) (default to false)
    includeSilent := false // bool | Include \"silent\" attributes in the response. (optional) (default to false)
    searchableOnly := false // bool | Include only \"searchable\" attributes in the response. (optional) (default to false)
    count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.IdentityAttributesAPI.ListIdentityAttributes(context.Background()).IncludeSystem(includeSystem).IncludeSilent(includeSilent).SearchableOnly(searchableOnly).Count(count).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IdentityAttributesAPI.ListIdentityAttributes``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListIdentityAttributes`: []IdentityAttribute
    fmt.Fprintf(os.Stdout, "Response from `IdentityAttributesAPI.ListIdentityAttributes`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiListIdentityAttributesRequest struct via the builder pattern

Name	Type	Description	Notes
includeSystem	bool	Include "system" attributes in the response.	[default to false]
includeSilent	bool	Include "silent" attributes in the response.	[default to false]
searchableOnly	bool	Include only "searchable" attributes in the response.	[default to false]
count	bool	If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information.	[default to false]

Return type

[]IdentityAttribute

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PutIdentityAttribute

IdentityAttribute PutIdentityAttribute(ctx, name).IdentityAttribute(identityAttribute).Execute()

Update Identity Attribute

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/sailpoint-oss/golang-sdk/v2"
)

func main() {
    name := "displayName" // string | The attribute's technical name.
    identityAttribute := *openapiclient.NewIdentityAttribute("uid") // IdentityAttribute | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.IdentityAttributesAPI.PutIdentityAttribute(context.Background(), name).IdentityAttribute(identityAttribute).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IdentityAttributesAPI.PutIdentityAttribute``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PutIdentityAttribute`: IdentityAttribute
    fmt.Fprintf(os.Stdout, "Response from `IdentityAttributesAPI.PutIdentityAttribute`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
name	string	The attribute's technical name.

Other Parameters

Other parameters are passed through a pointer to a apiPutIdentityAttributeRequest struct via the builder pattern

Name	Type	Description	Notes

identityAttribute | IdentityAttribute | |

Return type

IdentityAttribute

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

IdentityAttributesAPI.md

Latest commit

History

IdentityAttributesAPI.md

File metadata and controls

\IdentityAttributesAPI

CreateIdentityAttribute

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteIdentityAttribute

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteIdentityAttributesInBulk

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetIdentityAttribute

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListIdentityAttributes

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

PutIdentityAttribute

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers